Skip to content

API Standard

Overview

In the API world, there are not exists the best rules for all. They are different between the framework, the implemented language. By that, API standard is not exists. But there can be the best practices to follow.

And therefore, I breakdown the approach to see the API in the more structure way.

Target Method
Build the API Follow RFC
Fetch data from the API Follow Fetch Standard
Design schema Follow JSON schema organization

RFC Standard

Standard Title
RFC7230 Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing
RFC7230 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content
RFC7230 Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests
RFC7230 Hypertext Transfer Protocol (HTTP/1.1): Range Requests
RFC7230 Hypertext Transfer Protocol (HTTP/1.1): Caching
RFC7230 Hypertext Transfer Protocol (HTTP/1.1): Authentication

Fetch Standard

From the perspective of the Fetch

Fetch Standard

JSON Schema

JSON Schema