These forums have been archived and are now read-only.

The new forums are live and can be found at https://forums.eveonline.com/

EVE Technology Lab

 
  • Topic is locked indefinitely.
 

Swagger specs for some third party tools

Author
salacious necrosis
Garoun Investment Bank
Gallente Federation
#1 - 2015-12-22 19:06:42 UTC
All,

I've started a repository to house Swagger specs for some of the third party tools I rely on:

https://github.com/OrbitalEnterprises/swagger-specs

So far, I've added one spec for Eve Central (not all operations yet) and I'll likely add more. If you have requests, let me know and I'll see if I can crank a few more out. I'm also happy to take PR's if you'd like to contribute specs to the collection.

If you have no idea what Swagger is, the quick summary is: REST API description language with lots of useful tools for generating docs and clients. The docs on the Swagger site are pretty good. I've also done a slow walk through on my blog (see link below).

Before anyone asks, I DID try to make a Swagger spec for the EVE Online XML API endpoints but it doesn't quite work. You can get about 90% there but the problem is Swagger doesn't have great support for XML. You can read all about my attempt on my blog. I also tried RAML (RESTful API Modeling Language) which handles XML better, but has far fewer tools for turning specs into useful clients. I think we may see some JSON endpoints for this API soon, in which case a Swagger spec should be easy to do.

Some time ago someone made a Swagger spec for CREST but it was no longer available when I recently searched. CREST should be straightforward to describe since it is all json. If CCP annotated their CREST front end (hint hint) then it would be even easier to get the spec and build clients around it.

Use EveKit ! - Tools for EVE Online 3rd party development