Requirements:
- node
- docker
- From the root folder
swagger-node/
, runnpm run setup
- Start database and server with
npm run start
- Open
http://localhost:3000/api-docs
to see the Swagger-UI interface./api/v1
is the API endpoint, You can interact with it via any API service such as Postman
If you would like to edit the swagger-node/api/swagger.yml
file, you can either:
- Copy and paste the file into the online editor
- Run a local dockerized version of the editor
docker run -d -p 3001:8080 swaggerapi/swagger-editor
and opening the editor atlocalhost:3001