From 8386876e5a9f5406019745f8eeede8c120ba0f15 Mon Sep 17 00:00:00 2001 From: sudoblark-bot <141588119+sudoblark-bot@users.noreply.github.com> Date: Wed, 11 Sep 2024 12:01:58 +0100 Subject: [PATCH] README.md - initial creation by sudoblark.terraform.github --- README.md | 165 +----------------------------------------------------- 1 file changed, 2 insertions(+), 163 deletions(-) diff --git a/README.md b/README.md index 9ec7817..fe7bb7d 100644 --- a/README.md +++ b/README.md @@ -1,163 +1,2 @@ - -
-
- - Logo - - -

monsternames.open-api

- -

- OpenAPI definiton for the monsternames RESTAPI -

-
- - - - -
- Table of Contents -
    -
  1. - About The Project - -
    2. -
  2. Getting started
    3. -
  3. - Local development - -
    4. -
  4. CI/CD Setup
    5. -
  5. Contributing
    6. -
  6. License
    7. -
  7. Acknowledgments
    8. -
-
- - - - -## About The Project -This repo defines our OpenAPI definition for monsternames, and - via CI/CD - publishes -the SwaggerUI static website for monsternames. - -

(back to top)

- - - -### Built With - -* [Swagger](https://swagger.io) -* [OpenAPI specification 3.1.0](https://swagger.io/specification/) -* [Docker](https://hub.docker.com) -* [NPM](https://www.npmjs.com) - -

(back to top)

- - - - -## Getting Started - -1. Read the OpenAPI specification if you haven't already -2. Make changes to the specification -3. Submit a pull request -4. Check the produced SwaggerUI artefact in the pipeline -5. Once merged to main, the deployment will happen for you :) - - - -## Local Development -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. - -### Validating OpenAPI definition - -1. Install [swagger-cli](https://apitools.dev/swagger-cli/) from NPM: -```sh -npm install -g @apidevtools/swagger-cli -``` -2. Validate: -```sh -swagger-cli validate open-api.yaml -``` - -### Running SwaggerUI - -1. Clone the swagger-ui docker image: -```sh -docker pull swaggerapi/swagger-ui -``` - -2. 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 -``` - -3. Navigate to `localhost:8080` to see the swaggerUI - - -

(back to top)

- - - -## CI/CD setup - -```mermaid -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 -``` - - -## Contributing - -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! - -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the Branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request - -

(back to top)

- - -## License - -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. - -

(back to top)

- - - -## Acknowledgments - -* [Monster Creatures Fantasty](https://luizmelo.itch.io/monsters-creatures-fantasy) by luizmelo for the wonderful logo \ No newline at end of file +# sudoblark.monsternames.open-api +OpenAPI definition for the monsternames RESTAPI - repo managed by sudoblark.terraform.github