![]() ![]() While documenting, you specify the different servers that the API is operating on depending on the environment. While in a testing environment, it is on a testing server, and while in production, it is on a production server. ![]() While in a development environment, the API operates on a local server. Otherwise, your webpage should resemble the following:Ī screenshot of general info about the API Documenting API serversĭepending on the current environment of the API, it will be operating on different servers. In your browser, open your documentation page from.Ensure that the development server is up and running from your terminal.Feel free to add more in case you have a complex API as described here. Since our API is simple, there is not much information under the info object. Make sure to modify it to a latest supported version. Title : "Simple Todos API", // short title.ĭescription : "A simple todos API", // desc.Īt the time of writing this article, the latest supported version of openapi was 3.0.3. Openapi : "3.0.3", // present supported openapi version To install the dependencies, we need to run the following command at the root of the project:
0 Comments
Leave a Reply. |