This repository is to showcase my documentation of the Sunset and sunrise times API v2. The documentation was made as follows:
- Study the documentation of the Sunset and sunrise times API v2.
- Document the API according to the OpenAPI Specification v3.2.0.
- Linting and building the html file of the specification for static site generation.
- Uploading and publishing the html file for public viewing.
- Swagger Editor
- To document the OpenAPI specification while also previewing the output, and having the specification validated in real-time.
- ChatGPT
- To assist in figuring out how to structure certain components and schemas based on the documentation, and the sample JSON responses for documentation.
- Redocly CLI
- For linting and building the completed specification into a html file for publishing.
- GitHub
- For storing the required files for the documentation.
- GitHub Pages
- To publish the completed documentation.
You can view my final API documentation of the Sunset and sunrise times API v2 in here