Add Dexter-server Swagger documentation

Samsung / Dexter

Dexter is a static analysis platform to find and remove defects efficiently and immediately during the coding-time.

BSD 2-Clause "Simplified" License

56 stars 33 forks source link

Closed VeronikaSanko closed 5 years ago

VeronikaSanko commented 5 years ago

Create dexter-server specification with Swagger

dexter-server-spec

api_test

KarolAntczak commented 5 years ago

Overall, it looks great! :)

I have some general comments, though:

please rename folder "dist" into "swagger". Current name is a little confusing
"dist" contains a lot of 3rd party stuff (images,js,html). I would suggest to to keep only what is necessary to build swagger docs by user and provide instruction in README.md. Can this be done easily?

KarolAntczak commented 5 years ago

Please add short notice to README.md, regarding swagger, including how to run it and on what port it is available.