bustikiller/wedding-planner
1
0
Fork 0
Code Issues Pull Requests 5 Actions Packages Projects Releases Wiki Activity

Document the API using OpenAPI #127

Merged
bustikiller merged 6 commits from rswag-documentation into main 2024-11-15 18:49:11 +00:00
Conversation 0 Commits 6 Files Changed 11 +10
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 94b1066c17 - Show all commits

10
README.md
View File

@ -68,6 +68,16 @@ Unit tests can be executed with
bundle exec rspec
```
## API documentation
Generate the OpenAPI documentation with the command:
```
rake rswag:specs:swaggerize
```
The documentation is available in Swagger UI in http://libre-wedding-planner.app.localhost/api/api-docs/index.html. If testing the API through the UI, you will need to select the second server (which includes the `/api` path), intended for development.
## Contributing
Contributions of all kinds (code, UX/UI, testing, translations, etc.) are welcome. The procedures to contribute are still being defined, but don't hesitate to reach out in case you want to participate.