Skip to Content
RESTful Web API Design with Node.js 10 - Third Edition
book

RESTful Web API Design with Node.js 10 - Third Edition

by Valentin Bojinov
April 2018
Intermediate to advanced content levelIntermediate to advanced
178 pages
3h 51m
English
Packt Publishing
Content preview from RESTful Web API Design with Node.js 10 - Third Edition

Documenting RESTful APIs with Swagger

Public APIs exposed on the web should be well documented, otherwise it would be difficult for developers to use them in their applications. While WADL definitions might be considered a source of documentation, they address a different problem—the discovery of the service. They serve metadata for the services to machines, not to humans. The Swagger project (https://swagger.io/) addresses the need for neat documentation of RESTful APIs. It defines a meta description of an API from an almost human-readable JSON format. The following is a sample swagger.json file, partially describing the catalog service:

{  "swagger": "2.0",  "info": {    "title": "Catalog API Documentation",    "version": "v1"  },  "paths": { "/categories/{id}" ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

RESTful Web API Design with Node.js - Second Edition

RESTful Web API Design with Node.js - Second Edition

Valentin Bojinov
Hands-On RESTful API Design Patterns and Best Practices

Hands-On RESTful API Design Patterns and Best Practices

Harihara Subramanian J, Anupama Murali, Pethuru Raj

Publisher Resources

ISBN: 9781788623322Supplemental Content