gibahjoe / openapi-generator-dart

Openapi Generator for Dart/Flutter
BSD 3-Clause "New" or "Revised" License
112 stars 29 forks source link

feature or documentation request #138

Open dgaedcke opened 3 months ago

dgaedcke commented 3 months ago

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?