added a note about swagger ui & redoc integration

ash-project / ash_json_api

The JSON:API extension for the Ash Framework

https://hexdocs.pm/ash_json_api

MIT License

56 stars 40 forks source link

added a note about swagger ui & redoc integration #98

Closed yasoob closed 11 months ago

yasoob commented 11 months ago

When I followed the tutorial, I wasn't sure how to get swagger UI working. It took me a while and some research to figure out that the UI is not exposed by default and that I need to use open_api_spex. I hope this small note would help future readers.

Feel free to change the wording.

Contributor checklist

[ ] Bug fixes include regression tests
[ ] Features include unit/acceptance tests
[x] Documentation improvement

zachdaniel commented 11 months ago

🚀 Thank you for your contribution! 🚀