microsoft/api-guidelines
Api Guidelines
This project is a cloud API governance framework and enterprise style guide. It provides a centralized set of naming and structural rules and design guidelines for RESTful interfaces to maintain architectural consistency across large-scale distributed services.
The framework establishes standards for OpenAPI specifications to ensure a uniform developer experience. It also defines a versioning policy to manage service updates and prevent breaking changes for existing client integrations.
The guidelines cover resource-oriented design patterns, schema-based constraint validation, and standardized error mapping to ensure predictability and interoperability across multiple service endpoints.
Features
- API Style Guides - Provides a centralized set of naming and structural rules to maintain a uniform look and feel for network interfaces.
- Architectural Governance - Provides a centralized framework for enforcing architectural constraints and design goals across distributed cloud services.
- OpenAPI Processors - Utilizes the OpenAPI format as the machine-readable source of truth for service interface definitions.
- Specification Authoring Guidelines - Provides standardized style guidelines for OpenAPI documentation to ensure a uniform developer experience.
- Architectural Constraints - Enforces structural requirements on API definitions to ensure consistency across multiple service endpoints.
- API Documentation Standards - Implements standardized style guidelines for OpenAPI documents to ensure a uniform developer experience.
- API Design Standards - Establishes and enforces design standards and processes for evolving public-facing interfaces.
- API Governance Toolkits - Provides a comprehensive toolkit for enforcing API standards and maintaining consistency across distributed services.
- API Specification Governance - Standardizes the use of OpenAPI documents to ensure a predictable developer experience across services.
- API Versioning Strategies - Defines strategies for managing API versions to ensure service stability during updates.
- Distributed Service Architectures - Ensures architectural harmony across distributed systems through shared design constraints.
- Semantic Versioning Policies - Provides a structured semantic versioning policy to prevent breaking changes for client integrations.
- RESTful API Designs - Defines standard RESTful API designs utilizing HTTP methods for predictable data access.
- API Interface Standards - Establishes a centralized set of naming and structural rules to maintain a uniform look and feel for APIs.
- Schema Validation - Verifies that API definitions adhere to predefined naming and structural schemas.
- Error Handling Utilities - Normalizes and transforms error structures into a standardized set of codes and response bodies.
- Error Mapping Strategies - Maps internal application exceptions to a consistent set of external API error responses.
- Versioning Policies - Establishes formal strategies and rules for managing service updates to prevent breaking existing client integrations.
- Resource-Oriented Design - Implements resource-oriented design patterns to create interoperable and predictable service maps.
- RESTful Services - Organizes network interfaces using standard RESTful communication patterns and HTTP methods.
- Api Design - Battle-tested standards for building consistent RESTful APIs.
- API Design Guidelines - Industry-standard comprehensive API design principles and best practices.
- API Development - Standardized practices for designing consistent and usable web APIs.
- Design Guidelines - Official design principles for creating accessible and RESTful HTTP interfaces.
- Platform and API Guidelines - Standardized guidelines for REST API design.
- Design Guidelines - Official industry-standard guidelines for building scalable RESTful services.
