How do I get started with swagger-ui

restful-url swagger swagger-ui swagger-node-express
Saravanan Rajaraman picture Saravanan Rajaraman · Nov 28, 2014 · Viewed 27.8k times · Source

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

Are there any good resources to get started with swagger-ui? Any good tutorials, blogs or books?

i also vist http://swagger.io/ but i need more information.

please guide me. Thanks in adv

Answer

Ron picture Ron · Nov 30, 2014

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.

Related questions

Hyphen, underscore, or camelCase as word delimiter in URIs?

I'm designing an HTTP-based API for an intranet app. I realize it's a pretty small concern in the grand scheme of things, but: should I use hyphens, underscores, or camelCase to delimit words in the URIs? Here are my initial …

Read More
Passing array in GET for a REST call

I have a url to fetch appointments for a user like this: /user/:userId/appointments How should the url look like if I want to get appointments for multiple users? should it be: /appointments?users=1d1,1d2.. Thanks, Chris.

Read More
How to access the services from RESTful API in my angularjs page?

I am very new to angularJS. I am searching for accessing services from RESTful API, but I didn't get any idea. How can I do that?

Read More