...
- REST APIs should be described in a swagger.json file according to Open API Initiative.
- The swagger.json file should be put at the root path of the service url, such as: http(s)://[hostname][:port]/[ServiceType]/[ServiceName]/[Service Version]/Swagger.json
- The swagger.json can be automatically generated by JAVA notation, more information can be find at Swagger Annotations.
...
Operation | Register service to the Microservice Bus | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/microservices/v1/services | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Verb | POST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Success Code | 201 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Error Code | 422 Invalid Parameters |
...