README
¶
swagger
This directory contains ("swaggers") abbreviated copies of the following repositories:
- OpenAPI - https://github.com/swagger-api/swagger-ui v4.15.5 (LICENSE, dist/)
The swagger/OpenAPI directory contains HTML, Javascript,
and CSS assets that dynamically generate Swagger documentation from a
Swagger-compliant API definition in users.swagger.json
file. That file is auto-generated by running make generate in the root
of this repository. The static assets are copied from
this dist folder
of the OpenAPI-UI project. After copying, swagger-initializer.js
is edited to load the swagger file from the local server instead of the default petstore.
The steps above can be done automatically by using make generate/swagger-ui which is executing ./scripts/generate-swagger-ui.sh. The script will clone the OpenAPI repo with specific version defined by $SWAGGER_UI_VERSION and cache it at ./.cache/swagger-ui/$SWAGGER_UI_VERSION so if the script is running twice using the same version it will use the cache right away.
See the respective LICENSE files for each project for the applicable license terms.
Documentation
Source Files