Generating docs with Postman

[dizzydes]

Love the simplicity of this package.

Postman relies on Open API 3.0 conditions to auto generate docs (eg when a frontend dev wants to see endpoints). Does Ninja allow for this? Thanks

[vitalik]

@dizzydes do you have some example of the expected schema (and/or expected python type definition to describe it ) ?

[dizzydes]

Hey Vitalik It mentions here that *"If you are designing an API based on the OpenAPI 3.0 specification, Postman automatically creates documentation based on your API definition."* https://learning.postman.com/docs/publishing-your-api/documenting-your-api/#generating-api-documentation Thanks, Des

…

On Fri, Nov 25, 2022 at 10:55 PM Vitaliy Kucheryaviy < ***@***.***> wrote: @dizzydes <https://github.com/dizzydes> do you have some example of the expected schema (and/or expected python type definition to describe it ) ? — Reply to this email directly, view it on GitHub <#616 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACQHC57REUUVAZLY7MMOOP3WKEYURANCNFSM6AAAAAASLQA6QA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[vitalik]

@dizzydes

Ah - yes - django-ninja generates openapi3 spec - so you can pass it to tools like Postman, Swagger, redocs, etc.
just pass your-server/api/openapi.json to your doc generator

[dizzydes]

Amazing, thank you

On Sun 27 Nov 2022 at 10:24, Vitaliy Kucheryaviy ***@***.***> wrote: @dizzydes <https://github.com/dizzydes> Ah - yes - django-ninja generates openapi3 spec - so you can pass it to tools like Postman, Swagger, redocs, etc. just pass your-server/api/openapi.json to your doc generator — Reply to this email directly, view it on GitHub <#616 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACQHC5YBZXW5Y2PUHQ7KQILWKMSGRANCNFSM6AAAAAASLQA6QA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Thanks, Des