Skip to content

Latest commit

 

History

History
22 lines (20 loc) · 1.35 KB

README.md

File metadata and controls

22 lines (20 loc) · 1.35 KB

SampleSunsetSunriseAPI

This repository is to showcase my documentation of the Sunset and sunrise times API v2. The documentation was made as follows:

  1. Study the documentation of the Sunset and sunrise times API v2.
  2. Document the API according to the OpenAPI Specification v3.2.0.
  3. Linting and building the html file of the specification for static site generation.
  4. Uploading and publishing the html file for public viewing.

Tools used:

  1. Swagger Editor
    • To document the OpenAPI specification while also previewing the output, and having the specification validated in real-time.
  2. ChatGPT
    • To assist in figuring out how to structure certain components and schemas based on the documentation, and the sample JSON responses for documentation.
  3. Redocly CLI
    • For linting and building the completed specification into a html file for publishing.
  4. GitHub
    • For storing the required files for the documentation.
  5. GitHub Pages
    • To publish the completed documentation.

Final Output

You can view my final API documentation of the Sunset and sunrise times API v2 in here