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

Include OpenAPI information in the README
All checks were successful
Check usage of free licenses / check-licenses (pull_request) Successful in 55s
Details
Add copyright notice / copyright_notice (pull_request) Successful in 1m58s
Details
Run unit tests / unit_tests (pull_request) Successful in 2m34s
Details

Browse Source
This commit is contained in:
Manuel Bustillo 2024-11-15 19:09:55 +01:00
parent ca0b1b18d3
commit 94b1066c17
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -68,6 +68,16 @@ Unit tests can be executed with
bundle exec rspec 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 ## 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. 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.