From 94b1066c17dc87b70b076ce899bc2e7a18e91e15 Mon Sep 17 00:00:00 2001 From: Manuel Bustillo Date: Fri, 15 Nov 2024 19:09:55 +0100 Subject: [PATCH] Include OpenAPI information in the README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 4d4f615..49752d5 100644 --- a/README.md +++ b/README.md @@ -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.