rupadana / filament-api-service

A simple api service for supporting filamentphp
https://filamentphp.com/plugins/rupadana-api-service
MIT License
95 stars 22 forks source link

Feature api docs generator commands and stubs #51

Closed eelco2k closed 3 weeks ago

eelco2k commented 3 months ago

Rough work on Swagger API Docs generator CLI command with stubs.

improvements are always welcome.

rupadana commented 3 months ago

that was great update, mate. i will review it ASAP

rupadana commented 1 month ago

Hey @eelco2k , Thank for your contribution! 😄 . I Have some question & suggestion.

if we want to use it, transformer of the resource must be created, right?

Please update documentation about it.

and i think it better to use default Filament Resource namespace instead of creating new Virtual namespace

assume we have a App\Filament\Resources\BlogResource. Store the documentation into app\Filament\Resource\BlogResource\Api\Docs

eelco2k commented 1 month ago

I made the Virtual folder because swagger generator goes alphabetically through all files. If you would put the api files per resource it’s more probe to faults because it also look to the non Api folders as well. Other suggestions I will update after my vacation Thank you for your review and time.  if we want to use it, transformer of the resource must be created, right? Please update documentation about it. and i think its better to use default Filament Resource namespace instead of creating new Virtual namespace assume we have a App\Filament\Resources\BlogResource. Store the documentation into app\Filament\Resource\BlogResource\Api\Docs

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you authored the thread.Message ID: @.***>

eelco2k commented 1 month ago

@rupadana i've updated the readme and other files.

eelco2k commented 1 month ago

any updates on merging this PR?