search

tobyzerner / json-api-server

A JSON:API server implementation in PHP.
https://tobyzerner.github.io/json-api-server/
MIT License
63 stars 21 forks source link

Generating an OpenAPI spec #62

Open brayniverse opened 1 year ago

brayniverse commented 1 year ago

Hello 👋,

I have been manually creating a JSON:API implementation and while I think we've been doing a good job there has been mistakes along the way. When looking at this package I reckon we wouldn't have made as many if we were using json-api-server. I have been experimenting with the package and it seems really good.

All this is to say, I'm still new to the package and forgive me if this has already been asked. As far as I could tell, there hasn't been a discussion on it yet.

Is it possible to generate an OpenAPI spec file from the schema you define as part of json-api-server? It seems like all the information to generate one is available. If it is not currently possible, would you consider including it as part of the core package if I were to help implement it?

Thank you,

Chris

tobyzerner commented 1 year ago

Hey Chris, thank you for the kind words 😊

You're right that this hasn't been talked about before, but it's always been in the back of my mind as something that would be possible and desirable.

In a couple months I'm starting a new job that will allow me to invest a lot more time into this package, and I'd love to look at it then. In the meantime, any start you can make would be great!

brayniverse commented 1 year ago

@tobyzerner congratulations on the new job. I'll see what I can do.

tobyzerner commented 1 year ago

With the release of v1.0.0-alpha.1, which adds support for typed attributes, consider work on OpenAPI definition generation well underway :)

bertramakers commented 2 days ago

Hi @tobyzerner, is there any news regarding the OpenAPI spec support?