OpenAPI (formerly Swagger) specification of the REST API

thehyve / transmart-rest-api

HTTP available tranSMART RESTful API

Other

6 stars 12 forks source link

OpenAPI (formerly Swagger) specification of the REST API #30

Open blootsvoets opened 8 years ago

blootsvoets commented 8 years ago

It could be nice to specify the REST API using a OpenAPI (swagger) specification, see http://swagger.io. This documents the requests that clients are allowed to make and the format of the response data (especially useful for JSON requests and responses). Bonuses: formatted documentation, generated client SDKs and automated testing.

PiotrZakrzewski commented 8 years ago

Thanks Joris. This is indeed on our agenda ;)