Java Rest API Best Practices

Some of Best practices are followed as below

- Proper project structure
- Document with java docs
- keep base path meaningful and readable (use plurals EX : /users , /stocks ,/orders etc.. )
- Extended path should be clear to any person to understand
- User Response Entity to return responses with HTTP codes
- Identify and create utility methods
- Json format is mostly used for sending and retrieving data
- Avoid using HTTP methods (GET,PUT etc .) as method names
- Proper error handling with respect to methods
- Have proper versioning (Ex /users/v1/)
- Have proper logging
- Configure your log format
- Use log methods properly (info , debug , error etc )
- Do not log sensitive information

Please subscribe and share . Thanks .

Other Videos :
Spring boot admin server and client -
https://www.youtube.com/watch?v=rbKY5YAVL2w

Spring boot admin server-client on PCF - https://www.youtube.com/watch?v=9dRhBx6Jsj4

Swagger configuration for Spring boot -
https://www.youtube.com/watch?v=Tx4Fh25KqaU

Spring boot profiles -
https://www.youtube.com/watch?v=WYJUFtLLQTw

Spring boot Security - Authentication and Authorization Basics - https://www.youtube.com/watch?v=dJ95iOEMIU0

Thanks . Please subscribe and let me know in comments if any more information needed . Or if you want to hear any other topics