Swagger uses the OpenAPI spec to display API documentation in a clean and interactive way. The server now uses Swagger to do just this. Just access the /swagger endpoint in a browser to test it out! An instance of our Postgres database also needs to be running on your machine for this to work.
The server/swagger.json file contains all the information that Swagger uses to display the API. If we keep using this, any new API endpoint should be documented in this file. OpenAPI is relatively simple to use, and there is plenty of documentation online for it.
Swagger uses the OpenAPI spec to display API documentation in a clean and interactive way. The server now uses Swagger to do just this. Just access the /swagger endpoint in a browser to test it out! An instance of our Postgres database also needs to be running on your machine for this to work.
The server/swagger.json file contains all the information that Swagger uses to display the API. If we keep using this, any new API endpoint should be documented in this file. OpenAPI is relatively simple to use, and there is plenty of documentation online for it.