Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docker-compose to test Swagger documentation locally #7

Open
wants to merge 1 commit into
base: openapi3
Choose a base branch
from
Open

Add docker-compose to test Swagger documentation locally #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Gemnasium API documentation
# Gemnasium REST API v3 documentation

This repo host the Gemnasium API documentation.
## Start swagger on localhost

The documentation is currently written with the [API Blueprint](http://apiblueprint.org/) format and is available on [Apiary.io](http://docs.gemnasium.apiary.io/).
```
$ docker-compose up -d
$ echo -e "\nBrowse to http://`docker-compose port swagger 8080`\n"

Browse to http://0.0.0.0:32782

```
10 changes: 10 additions & 0 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: '2'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you know this version is deprecated? :)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know https://docs.docker.com/compose/compose-file/compose-versioning/

services:
swagger:
image: swaggerapi/swagger-ui:latest
environment:
API_URL: openapi3.yaml
ports:
- 8080
volumes:
- ./openapi3.yaml:/usr/share/nginx/html/openapi3.yaml