Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I get started with swagger-ui [closed]

Tags:

What is swagger-ui and what is the use of it?

I have visited http://swagger.io/, but I need more information.

Please guide me.

like image 566
Saravanan Rajaraman Avatar asked Nov 28 '14 12:11

Saravanan Rajaraman


People also ask

How do I get to Swagger UI?

Go to http://localhost:8000/ in your address bar. This address lets you view the local web server. By default, web servers default to the index. html file in the directory, so it will show the Swagger UI file automatically.


1 Answers

Swagger UI is a tool that takes Swagger specification files, presents them visually and allows you to execute operations.

Swagger itself is a specification to document and describe REST APIs. The specification can be found here - https://github.com/swagger-api/swagger-spec/. The repository contains the specification itself, json schema, samples and so on. The main README of the repository also points you to additional tools including libraries and frameworks to produce your specifications.

When it comes to creating Swagger specification, you can use one of the frameworks and integrate it with existing code to auto-generate such documentation.

If you don't have an existing application or would rather document it manually, you can use the Swagger-Editor tool or the text editor of your choice.

like image 86
Ron Avatar answered Oct 10 '22 03:10

Ron