API Standards

The API standards group is an open working group that is focused on creating a set of standards for the development of APIs. The goal of this group is to create a set of standards that will allow for the creation of APIs that are consistent, easy to use, easy to maintain, and which meet the goals and priorities of the Angular Standards Group.

The group was formed on 05-08-2023.

The group is focused on exploring the following topics:

• Standard HTTP Methods & Status Codes
• Standard Naming of Endpoints
• Standard Naming of Domain Names
  • Subdomains
• Standard structure for response body
  • Standardized messages and errors between client and server
  • Define Scenarios and Categories of Response Errors
• Standard for API Versioning and Deprecation
• OpenAPI Schemas (FKA Swagger)
• Testing of all items listed above.

The group also plans to consider the following technologies and patterns.

• GraphQL
• gRPC
• John’s "rest plus" library & related patterns
• Shared schema definitions: e.g. Apache Avro or LinkML

Get Involved!

Follow the latest developments by:

• Joining the API Standards Slack Channel: #api-standards on the JAX Slack Workspace.
• Investigating the API Standards Epic on the DEVOPS Jira Board: Epic Link
• Joining the API Standards Working Group by contacting Alexander Berger or messaging the #api-standards channel on the JAX Slack Workspace.