davpin / cf-SpringBootTrader

Microservice version of the Spring Trader app using Spring Boot and Spring Cloud.
Apache License 2.0
104 stars 107 forks source link

API versioning #11

Open davpin opened 8 years ago

davpin commented 8 years ago

improve controllers so we can have better API management (i.e. versioning). For example, have "/v1/" in the path so we can have multiple concurrent versions.

Also, try to improve APIs (format, syntax, structure, docs).

davpin commented 8 years ago

look into swagger (http://swagger.io), Springfix (http://springfox.github.io/springfox/) and Spring Rest Docs (https://github.com/spring-projects/spring-restdocs), HAL (https://github.com/mikekelly/hal-browser).

Idea is to make the APIs, more mature, maybe even Hypermedia APIs with documentation.