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

Swagger API spec is incomplete/outdated #85

Closed
seriousme opened this issue Jan 21, 2017 · 3 comments · Fixed by #1245

Comments

@seriousme
Copy link

commented Jan 21, 2017

Hi,

I noticed in https://github.com/fission/fission/blob/master/Documentation/Architecture.md that a swagger spec is mentioned.
However api/swagger.json does not exist (anymore ?)

In my view the project would benefit from formally specified API's between the components.
Say one would like to build a fission dashboard then having to go through the Go code to find the URL's is rather cumbersome. Its much easier to generate a javascript client from a swagger spec.

And if you would like to take it even further then its possible to generate a the server stubs, the client stubs and even the command-line client (e.g. using http://swagger.io/tools/ or https://goa.design/ )

Last but not least: formally specifying the API's increase security as it stops invalid inputs early in the process :-)

Cheers,
Hans

@soamvasani

This comment has been minimized.

Copy link
Member

commented Jan 23, 2017

Totally agree with the need for an API spec. I started writing a swagger spec, but didn't finish it. It's in the swagger-api-spec branch.

@soamvasani soamvasani changed the title formal specification of the API's ? Swagger API spec is incomplete/outdated Jan 23, 2017

@soamvasani soamvasani added the bug label Jan 23, 2017

@life1347 life1347 added this to the 1.5 milestone Jul 8, 2019

@life1347 life1347 referenced this issue Jul 8, 2019
@life1347

This comment has been minimized.

Copy link
Member

commented Jul 8, 2019

The packagego-restful, which is also used by kubernetes, that allows us to define RESTful API route and generate swagger.json from the code automatically. Since the controller APIs are stabilized, I put this issue into 1.5 milestone.

example: https://github.com/emicklei/go-restful/blob/master/examples/restful-swagger.go

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.