You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi I was looking to the implementation but still don't know how to interact with a service.
It is possible to see an example with a simple service?
Also a license would be awesome, thanks
Well not really, in fact I found your repo because right now I'm moving from a monolitic Laravel app to microsevices written in Lumen.
So does it mean that you have to use an specific modeling lang like swagger o RAML?
Thanks again
You can either do it manually by providing your API gateway routes in GATEWAY_ROUTES environment variable, or you could parse Swagger JSON automatically. Swagger is just a nice way
I agree that it would be awesome to have some configuration examples (in my case swagger based microservice, but any further hint would be really appreciated) Thanks!.
@dusterio Hi Dusterio, where you able to add examples? The doc really does not make sense. I'm pretty sure that no one can run the full example, especially Swagger parts. It would be nice to have working examples with Swagger support.
@spacecomx your microservices are expected to expose Swagger documentation endpoints (version 1), all actions will be imported upon start. routes.json is an internal, auto-generated file - a result of parsing of those Swagger endpoints.
@spacecomx I've just checked and Petstore is only provided in Swagger v2, it didn't exist till v2 I suppose. I guess it's time to add Swagger v2 support to Vrata.
The reason I stuck with v1 only originally is - all major frameworks I checked at that time (~6 months ago) only had packages for v1.
Thank you so much for this awesome gateway. I am trying to use this one however I have a couple questions about swagger. Until I know there are two ways to generate documentation for an API using swagger.
1 - Using the public swagger editor: https://swagger.io/. It generates API documentation and lets you share and collaborate with people. I am able to export my documentation but I do not know how to use the exported documentation ( swagger.json ) to discover it. through the gateway. I think I need to create a controller, route ,etc.
2 - Using some composer packages that generates that documentation. To generate the documentation , basically you need to use the swagger notation in each controller and function. The package exposes your documentation so the gateway can discover the service.
Based on your experience, what is the best approach to document an API. If you use some composer package for lumen, Could you share the name please.
Activity
dusterio commentedon Feb 2, 2017
I've just added a license - thanks for noticing this! :)
Sure, we can provide an example. Does your simple microservice have Swagger documentation?
alejogutierrez commentedon Feb 2, 2017
Well not really, in fact I found your repo because right now I'm moving from a monolitic Laravel app to microsevices written in Lumen.
So does it mean that you have to use an specific modeling lang like swagger o RAML?
Thanks again
dusterio commentedon Feb 2, 2017
You can either do it manually by providing your API gateway routes in GATEWAY_ROUTES environment variable, or you could parse Swagger JSON automatically. Swagger is just a nice way
alejogutierrez commentedon Feb 2, 2017
Fine I'm going to take a look using swagger.
reindeer77 commentedon Feb 8, 2017
I agree that it would be awesome to have some configuration examples (in my case swagger based microservice, but any further hint would be really appreciated) Thanks!.
dusterio commentedon Feb 8, 2017
Sure, you are right. Will add some examples tomorrow!
moon0326 commentedon Jun 9, 2017
@dusterio Hi Dusterio, where you able to add examples? The doc really does not make sense. I'm pretty sure that no one can run the full example, especially Swagger parts. It would be nice to have working examples with Swagger support.
dusterio commentedon Jun 9, 2017
@moon0326 I did but perhaps it wasn't enough :) I will review the documentation today and make sure it's comprehensive!
moon0326 commentedon Jun 9, 2017
@dusterio Thank you so much!
dusterio commentedon Jun 20, 2017
@spacecomx your microservices are expected to expose Swagger documentation endpoints (version 1), all actions will be imported upon start. routes.json is an internal, auto-generated file - a result of parsing of those Swagger endpoints.
dusterio commentedon Jun 20, 2017
@spacecomx I've just checked and Petstore is only provided in Swagger v2, it didn't exist till v2 I suppose. I guess it's time to add Swagger v2 support to Vrata.
The reason I stuck with v1 only originally is - all major frameworks I checked at that time (~6 months ago) only had packages for v1.
dusterio commentedon Jun 20, 2017
@spacecomx I'll check tomorrow! if it's something simple (the difference is not too big) - I will add a v2 parser tomorrow :)
rizwanmcs commentedon May 24, 2018
where we will define routes mapping in this project?
harunnryd commentedon May 28, 2018
@dusterio Hi, where you able to add examples? :(
agungsugiarto commentedon Dec 27, 2019
no example with swagger :(
eddycastillon commentedon Aug 18, 2020
Thank you so much for this awesome gateway. I am trying to use this one however I have a couple questions about swagger. Until I know there are two ways to generate documentation for an API using swagger.
1 - Using the public swagger editor: https://swagger.io/. It generates API documentation and lets you share and collaborate with people. I am able to export my documentation but I do not know how to use the exported documentation ( swagger.json ) to discover it. through the gateway. I think I need to create a controller, route ,etc.
2 - Using some composer packages that generates that documentation. To generate the documentation , basically you need to use the swagger notation in each controller and function. The package exposes your documentation so the gateway can discover the service.
Based on your experience, what is the best approach to document an API. If you use some composer package for lumen, Could you share the name please.
Thank you
harunnryd commentedon Aug 18, 2020
@eddycastillon you can use my api gateway bro :) https://github.com/harunnryd/gateid