1. RIS-API (Ratshausinformationssystems), Gemeinderat Stadt Zürich (GRZ)
2. Zürich Tourismus API

This repository is based on this blogpost: https://peterevans.dev/posts/how-to-host-swagger-docs-with-github-pages/

The following notes help to setup a new API documentation project.

1. Download the latest stable release of the Swagger UI here.

2. Extract the contents and copy the "dist" directory to the root of your repository.

3. Create a new directory for the API you want to describes

   mkdir -p my-api/docs
   

4. Move the file "index.html" from the directory "dist" to the new api directory.

   mv dist/index.html my-api/docs
   

5. Copy the YAML specification file for your API to the api directory.

6. Edit index.html and change the url property to reference your local YAML file.

       const ui = SwaggerUIBundle({
           url: "swagger.yaml",
       ...

7. Then fix any references to files in the "dist" directory.

   ...
   <link rel="stylesheet" type="text/css" href="../../dist/swagger-ui.css" >
   <link rel="icon" type="image/png" href="../../dist/favicon-32x32.png" sizes="32x32" />
   <link rel="icon" type="image/png" href="../../dist/favicon-16x16.png" sizes="16x16" />    
   ...
   <script src="../../dist/swagger-ui-bundle.js"> </script>
   <script src="../../dist/swagger-ui-standalone-preset.js"> </script>    
   ...

8. Add a README.md in the api directory to describe the API

   touch my-api/README.md
   

# create a new virtualenv
virtualenv --no-site-packages pyenv
source ./pyenv/bin/activate

# install dependencies
pip install -r requirements.txt

Run the jupyter notebook:

./pyenv/bin/jupyter notebook