-
Notifications
You must be signed in to change notification settings - Fork 8
Documentation
Swagger is an open source software framework sponsored by SmartBear. Swagger is used to create, document and consume RESTful Web services. Swagger offers an easy way to document RESTful Web services by using Swagger documentation definitions and Swagger UI to document an API and give an example of how the API works. Swagger works by having the developer add comments similar to java-docs in order to document a route telling swagger the components of the route and the model it uses. Giving swagger this information swagger will use the data to create a JSON object with all the data about the API in a format that can be used by the developer for other means or to be used in conjunction with swagger UI
JSDoc is a markup language used to annotate JavaScript source code files. JSDoc is aport of JavaDoc for JavaScript and TypeScript.
The dissertation fully documents our project