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

feature or documentation request #138

Open
dgaedcke opened this issue Mar 10, 2024 · 1 comment
Open

feature or documentation request #138

dgaedcke opened this issue Mar 10, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@dgaedcke
Copy link

Description of the bug

I'm a bit confused ... does this package allow me to decorate my router (shelf) endpoints and generate OpenAPI specs directly off my actual server API (types in and out) ? Or must I do a bunch of manual input to mirror the actual router configuration? I'm wanting a library that uses my actual API endpoint code to determine what the OpenAPI contract entails.
I've used apispec (https://apispec.readthedocs.io/en/latest/) with Python to achieve similar code-gen. Can or do you support this approach?

Steps to reproduce

Can't find answer in existing docs

Expected behavior

need more docs

Logs

No response

Screenshots

No response

Platform

macOS

Library version

10.7.6

Flutter version

3.2

Flutter channel

stable

Additional context

Does this package allow me to decorate my router (shelf) endpoints and generate OpenAPI specs directly off my actual server API  (types in and out) ?  Or must I do a bunch of manual input to mirror the actual router configuration?  I'm wanting a library that uses my actual API endpoint code to determine what the OpenAPI contract entails.
I've used apispec (https://apispec.readthedocs.io/en/latest/) with Python to achieve similar code-gen.  Can or do you support this approach?
@dgaedcke dgaedcke added the bug Something isn't working label Mar 10, 2024
@Nexushunter
Copy link
Contributor

At the moment, this library generates from an OAS spec.

I definitely like the idea of having annotations that would that. I think that would be better implemented once we have macros. Currently, it appears that would be possible post Q1 2025.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants