elepy icon indicating copy to clipboard operation
elepy copied to clipboard

OpenAPI for generated api

Open RyanSusana opened this issue 6 years ago • 3 comments

RyanSusana avatar Nov 19 '19 11:11 RyanSusana

Hi, first at all Nice project !!

Do you need generate open api docs to use with something like swagger ui for the dynamic resources endpoints generated by elepy ?

Do you need some help with that or anything with higher priority? My english is awful, but i like to programming .

danielcaro avatar Aug 13 '20 04:08 danielcaro

Hello man, thank you!

I'm still trying to figure out a good way to generate OpenAPI docs.

I need to take the following into consideration:

  • Default endpoints
  • Custom endpoints
  • Authorization and Authentication

RyanSusana avatar Aug 13 '20 12:08 RyanSusana

Maybe, the easiest will the default endpoints used to manage Elepy, but looks more useful for the user the custom endpoints to allow user to know the custom CMS endpoints to use. For me , makes me more sense to start with OpenApi docs for the custom endpoints.

And about Authorization and Authentication, is about: 1) how to access to OpenApi docs? or 2) how the OpenApi docs describe the way to submit security parameters to the endpoints ?

danielcaro avatar Aug 13 '20 18:08 danielcaro