Re: Traffic Ops API Swagger Doc

I mentioned a week ago if we should use Swagger for documenting the API (with my example findings). Since I have seen no -1's the plan is to move forward with Swagger and only document the Golang Proxy routes (1.3), the Perl routes will still use the existing 1.2 API docs. In terms of how we

Re: Traffic Ops API Swagger Doc

Eric, are you saying you never want to write RST anymore? me neither. yuck! On Tue, Feb 20, 2018 at 9:57 AM, Eric Friedrich (efriedri) < efrie...@cisco.com> wrote: > Is it possible to take the swagger generated documentation and have that > automatically included in the read-the-docs site? > >

Re: Traffic Ops API Swagger Doc

Eric: Out of curiosity I was able to generate it with the tooling I mentioned here: https://github.com/dewrich/incubator-trafficcontrol/blob/swagger-demo/traffic_ops/traffic_ops_golang/docs/swagger.rst -Dew On Tue, Feb 20, 2018 at 10:38 AM, Dewayne Richardson wrote: > Yes

Re: Traffic Ops API Swagger Doc

Yes the plan was to get the initial thumbs up, then figure out how we can deploy it (by default swagger generates interactive, meaning it needs a server, UI doc). A quick internet search says there does look like tooling for converting swagger docs to .rst (

Re: Traffic Ops API Swagger Doc

Is it possible to take the swagger generated documentation and have that automatically included in the read-the-docs site? Asked another way: Can swagger generate docs in ReStructed Text (.rst) format? —Eric > On Feb 20, 2018, at 11:38 AM, Dave Neuman wrote: > > Sounds

Re: Traffic Ops API Swagger Doc

Sounds good. I look forward to seeing it merged into our repo. I guess this means there will need to be a PR to remove our current API docs as they get moved to swagger. On Tue, Feb 20, 2018 at 8:40 AM, Jeremy Mitchell wrote: > I think this all sounds very promising.

Re: Traffic Ops API Swagger Doc

I think this all sounds very promising. Some advantages that I see are: - docs never drift from API implementation (currently our docs get out of sync real fast) - this provides yet another interface - https://app.swaggerhub.com/apis/dewrich/traffic-ops_api/1.3 - (in addition to TP) to interact

Re: Traffic Ops API Swagger Doc

I am +1 on the swagger concept. This makes working with APIs much easier for non-developer staff and makes it easier to educate customers as well. Ryan DurfeyM | 303-524-5099 CDN Support (24x7): 866-405-2993 or cdn_supp...@comcast.com From: Dewayne