[ADP-1] Purpose of ADP

Goals

• One of the goals of this document is to establish a standard so that every API designer within the company can create APIs that appear to be designed by the same person.
• Ensure that all API designs follow unified best practices and guidelines, promoting consistency and quality across all projects.
• Facilitate better collaboration among teams by providing common specifications and recommendations for API design, making APIs from different business units easier to understand and integrate.
• Ensure that API design prioritizes both developer experience and end-user experience, creating more robust, user-friendly, and developer-friendly applications.
• Enhance the overall security and reliability of APIs across the organization.
• Promote the importance of API as a product/API First through publicly available design specifications.
• Facilitate communication among developers.

Writing Guidelines

Refer to ADP Writing Guidelines

Violating Guidelines

• If you need to violate certain guidelines, you can specify the violated ADP.

  TIP

  💡 If there is sufficient reason to violate, you should provide feedback for this document to consider changes to the overall specifications.