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.
- Create a GitHub repository to store and publish the API documentation.
- Lint the API specification through a pull request.
- Building and deploying the specification documentation through GitHub Actions for public viewing.
- Swagger Editor
- To document the OpenAPI specification while also previewing the output, and having the specification validated in real-time.
- Claude
- To assist in figuring out how to structure certain components and schemas based on the documentation, and the sample JSON responses for documentation.
- GitHub
- For storing the required files for the documentation.
- Running the Redocly linting process of the OpenAPI file before merging with GitHub Actions.
- Building and deploying the linted OpenAPI file after merging with GitHub Actions.
You can view my final API documentation of the Sunset and sunrise times API v2 in here
- The
openapi.ymlfile is the OpenAPI specification file. This file will be updated in a local repository and pushed to GitHub with a pull request in the future. - In the
.\.github\workflowsapi-lint.ymlis the workflow file that triggers upon a pull request to lint the updatedopenapi.ymlfile.deploy-docs.ymlis the workflow file that triggers upon merging the pull request to the 'main' branch to build and deploy the documentation to the live page.