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

Integrating UI Into An Existing API #976

Closed
captjt opened this Issue Mar 27, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@captjt
Copy link

captjt commented Mar 27, 2017

Integrating UI Into An Existing API

Is there anyway to easily integrate documentation and a client without having to auto generate a server API?

I don't want my API server to be auto generated for me when I already have a complex service finished. Another reason I want this capability is because I have to support many transports (gRPC & http) in a microservices architecture.

I just want to have an easy way to document the service and supply a frontend for other to interact with.

Thanks!

@casualjim

This comment has been minimized.

Copy link
Member

casualjim commented Mar 27, 2017

the 2 things are orthogonal concerns. Whatever serves the UI in go-swagger is just a middleware
https://github.com/go-openapi/runtime/blob/master/middleware/redoc.go

to integrate swagger-ui you would need to figure out how to serve the static files and call the UI with: ?url=https://example.com/swagger.json

@casualjim casualjim added the question label Mar 27, 2017

@captjt

This comment has been minimized.

Copy link

captjt commented Mar 29, 2017

@casualjim that's exactly how we are going to have to do it. Thank you for your help.

@captjt captjt closed this Mar 29, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment