[SUBMARINE-481] Use Swagger to describe and document submarine RESTful APIs

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.4.0
• Component/s: Doc
• Labels: pull-request-available
• Target Version: 0.4.0
• Assignee: Kevin Su
• Reporter: Kevin Su
• Created: 23/Apr/20 01:21
• Updated: 13/May/20 08:54
• Resolved: 13/May/20 08:54

Description

Follow JobManagerRestApi.java and Job.java , submarine-server doc to define our job API by swagger

We could copy swagger.ymal to https://editor.swagger.io/ so that we could automatically generate doc and related client API.

Anything I miss or something that needs to modify, please let me know

cc leftnoteasy liuxun jiwq tangzhankun 

Issue Links

• links to: experiment.yaml
• links to: GitHub Pull Request #271
• links to: Submarine Experiment spec