fancard-capstone / fancard-server

Repository for backend server for Fancard mobile application
GNU General Public License v3.0
0 stars 0 forks source link

Create API documentation in Swagger/ Postman #4

Open sajald77 opened 8 months ago

sajald77 commented 8 months ago

This would be the official documentation that vendors with open API use to allow developers to use their service. This would be accurate representation of API, The source of truth would be based off of:

API structure which would be the list of API's and how each one would be used for frontend, and which Database entity is it connected to ( one or more). Also the method ( put, post, get, delete) would be mentioned

Exact parameters are derived from ERD diagram. We're going with returning all relevant data for particular API, for simplicity sake. ( for eg: when fetching user, we get all user information). Follow CRUD principle while doing this.