Table of Contents
This repo defines our OpenAPI definition for monsternames, and - via CI/CD - publishes the SwaggerUI static website for monsternames.
- Read the OpenAPI specification if you haven't already
- Make changes to the specification
- Submit a pull request
- Check the produced SwaggerUI artefact in the pipeline
- Once merged to main, the deployment will happen for you :)
The below instructions are to assist local development of the OpenAPI definition and/or SwaggerUI.
All instructions, unless otherwise stated, were only tested on MacOS.
- Install swagger-cli from NPM:
npm install -g @apidevtools/swagger-cli
- Validate:
swagger-cli validate open-api.yaml
- Clone the swagger-ui docker image:
docker pull swaggerapi/swagger-ui
- Run it, mounting our local
open-api.yaml
file:
docker run -it \
--mount type=bind,source="$(pwd)"/open-api.yaml,target=/usr/share/nginx/html/open-api.yaml \
-p 8080:8080 \
-e API_URL=open-api.yaml \
swaggerapi/swagger-ui
- Navigate to
localhost:8080
to see the swaggerUI
flowchart TD
subgraph open_pull_request[Open Pull Request]
validator[Validate Swagger]
end
subgraph on_merge_to_main[On merge to main]
github_deployment[Update GitHub deployment]
deploy_artefact[Deploy to S3]
deploy_artefact --> github_deployment
end
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Copyright (c) 2023, Sudoblark Ltd
All rights reserved.
This source code is licensed under the BSD 3 clause license found in the LICENSE file in the root directory of this source tree.
- Monster Creatures Fantasty by luizmelo for the wonderful logo