APIs are designed to be used by other people. These users need an easy way to know the capabilities of an API without reading source code. In this video, we will take a look at the tools for generating API documentation.
- [Instructor] In the previous video, we looked at security…considerations for building APIs.…In this video, we are going to look at…delivering high quality documentation.…We are going to take a look at two kinds…of documentation generation tools:…annotation-based documentation and API design languages.…We will generate an HTML page from an API design file.…Finally, we will run a mock server of our API.…First, let's take a look at APIDOC,…an annotation-based documentation generation tool.…
Annotation-based documentation is…written within the code files,…usually in the form of block comments.…This example shows what a documentation…for a user end point looks like.…This block comment is usually placed right before…the definition of the route that it refers to.…Another form of documentation is API design files.…These are separate files that are only…used for documentation purposes.…The two most popular API design languages,…are Swagger…and API Blueprint.…
In this video, we will use API Blueprint…to demonstrate API design files.…
This Node.js training course gives you an overview of a RESTful API and the logical steps of building one. It explores three different APIs, focusing on their similarities and differences to effectively implement one. Author Saleh Hamadeh starts off by defining APIs, showing how they can be built on top of HTTP and listing the properties that make an API RESTful. Then learn how to develop Twitter Notes, a sample web application that lets its users leave notes for their Twitter friends. You'll use Twitter's API to implement a login flow and then design a web API. In addition, you'll get a closer look at two other real-world APIs—Facebook API and GitHub API. Finally, learn some best practices to keep APIs secure, maintainable, and efficient.
- Identifying REST resources
- Setting up the development environment
- Consuming a RESTful API
- Creating an OAuth login request
- Getting an access token
- Saving data in MongoDB
- Building a RESTful API
- Looking at APIs in the real world
- Best practices for building RESTful APIs