-
-
Notifications
You must be signed in to change notification settings - Fork 21
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
Generating an OpenAPI spec #62
Comments
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! |
@tobyzerner congratulations on the new job. I'll see what I can do. |
With the release of v1.0.0-alpha.1, which adds support for typed attributes, consider work on OpenAPI definition generation well underway :) |
Hi @tobyzerner, is there any news regarding the OpenAPI spec support? |
Hi @bertramakers, work is in progress (but incomplete) on the use Tobyz\JsonApiServer\OpenApi\OpenApiGenerator;
$api = new JsonApi();
// $api->resource(...) etc
$generator = new OpenApiGenerator();
print_r($generator->generate($api)); // or encode as json, yaml |
Thanks, I'll try it out soon!
Edit: Disregard this, it makes sense to put |
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
The text was updated successfully, but these errors were encountered: