Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

poem_openapi description #269

Closed
jonathanblade opened this issue Apr 29, 2022 · 2 comments
Closed

poem_openapi description #269

jonathanblade opened this issue Apr 29, 2022 · 2 comments
Labels
question Further information is requested

Comments

@jonathanblade
Copy link

Is it possible to add description to API methods and schemas?

@jonathanblade jonathanblade added the question Further information is requested label Apr 29, 2022
@sunli829
Copy link
Collaborator

Use the rust doc:

    #[OpenApi]
    impl Api {
        /// description
        #[oai(path = "/", method = "get")]
        async fn test(&self, ...) {
             ...
        }
    }

@jonathanblade
Copy link
Author

Wow, ty 😀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants