ADE Document List

• 0.ADE Overview
• 1.Purpose of ADP
• 2.ADP Writing
• 3.ADP Numbering
• 4.Glossary
• 5.ADP Implementation Guide 1st phase
• 20.Engineering Principles
• 21.Best Practices
• 22.API First
• 23.Developer Experience
• 24.Versioning Mechanism
• 40.API Governance Overview
• 41.API Versioning
• 42.API Lifecycle Management
• 43.API Rate Limiting
• 44.API Testing
• 45.API Monitoring
• 46.API Guideline Exception
• 47.API Authentication and Authorization
• 48.API Robustness
• 49.API Term Registration
• 50.API Landscapes
• 51.API Review
• 52.API Health Check
• 53.API as a Product
• 54.OAuth2.0/OIDC for API
• 55.API Key
• 56.Microservice API
• 57.API Spec discoverability
• 58.API Monetization
• 80.Naming Convention Overview
• 81.MIME type naming convention
• 82.URN naming convention
• 100.HTTP Basics Overview
• 110.HTTP Methods
• 111.GET
• 112.POST
• 113.PUT
• 114.DELETE
• 115.PATCH
• 117.PATCH Request Content-Type
• 120.HTTP Headers
• 121.Common HTTP headers
• 122.Accept
• 123.Authorization
• 124.Cache-Control
• 125.Content-Range
• 126.Content-Type
• 127.Deprecation
• 128.ETag
• 129.Expect
• 130.Idempotent-Key
• 131.If-Match
• 132.If-Modified-Since
• 133.If-None-Match
• 134.Last-Modified
• 135.Location
• 136.Prefer
• 137.Range
• 138.Rate Limit Headers
• 139.Retry-After
• 140.Sunset
• 141.User-Agent
• 142.X-Request-Id
• 143.Expires
• 144.Vary
• 145.Link
• 146.Accept-Post
• 147.Accept-Patch
• 148.Server
• 149.If-Unmodified-Since
• 150.Soft Deletion
• 151.Content-Disposition
• 152.X-HTTP-Method-Override
• 200.HTTP Status
• 201.HTTP Status 504
• 202.Not Found v.s. Forbidden
• 300.REST Overview
• 301.Resource-Oriented Design
• 302.URI Design Principles
• 303.Clean and Clear URL Path
• 304.Plural Forms of Collections
• 305.API in Relative URI Path
• 306.URI Design Patterns
• 307.Inspiring URI Design Collection
• 308.Resource Design Misc
• 309.URI format convention
• 310.Collection Semantics
• 311.Filtering
• 312.Pagination
• 313.Sorting
• 314.Resource Identifier
• 315.REST maturity
• 316.Response primary type
• 317.JSON response
• 318.Query Parameter Convention
• 319.Request Body Convention
• 320.Array Convention
• 321.Omit Empty
• 322.Hypermedia Alternatives
• 350.HTTP Semantics Overview
• 351.Range Request
• 352.Conditional Requests
• 353.Content Negotiation
• 354.Client Hints
• 355.Request with Preference
• 356.Batch Request
• 357.Long Running Job
• 358.Partial Request
• 359.Partial Response
• 360.Resource Expansion
• 361.HTTP Caching
• 362.Concurrency Control
• 363.Custom Authorization Schema
• 364.Custom Header Fields Design
• 365.Custom Status Code
• 366.Idempotency
• 367.HTTP Profile
• 368.HTTP Expect
• 369.HTTP Caching ETag
• 370.HTTP Caching Last-Modified
• 371.HTTP Caching Cache-Control
• 372.Server-Sent Messages
• 373.Server Side Event
• 374.WebSocket API Design Guide
• 375.Using 'expand' query parameter
• 400.Error Design Overview
• 401.HTTP Problem Basics
• 402.Empty Problem Type
• 403.Problem Type Design
• 404.validation-error design
• 405.Inspiring HTTP Problem Redesign
• 406.Collection of Heuristic Question Types
• 410.Third-Party Service Error Abstraction
• 600.Event Design Overview
• 601.Event as part of API design
• 602.CloudEvents
• 603.CloudEvents Type Conventions
• 604.CloudEvents source
• 605.CloudEvents Media Type
• 606.CloudEvents Testing Marker
• 607.Event Tracing
• 608.Temporary Events
• 609.Event Partitioning
• 610.Event Ordering
• 611.Event Severity
• 612.Event Recording Time
• 700.Overview of JSON Design
• 701.Attribute Design
• 702.Enumeration Value Conventions
• 703.Date and Time Field Conventions
• 704.ID Field Convention
• 705.Name Field Convention
• 706.null and absent semantic
• 707.Date-time and Time Data
• 708.Time Zone Data
• 750.Overview of OpenAPI Design
• 751.New OpenAPI document
• 752.OpenAPI API audience
• 753.OpenAPI x-rate-limit
• 754.OpenAPI JSON Schema
• 755.OpenAPI operationId
• 756.OpenAPI Provide Examples
• 757.OpenAPI x-violated-adp
• 758.OpenAPI $ref
• 759.OpenAPI Contact info
• 760.OpenAPI webhooks
• 761.OpenAPI public shared schemas
• 762.OpenAPI HTTP Profile basis
• 763.OpenAPI implicit resource indication
• 764.OpenAPI format conventions
• 765.OpenAPI timezone format
• 766.OpenAPI country code format
• 767.Re-use shared common HTTP headers
• 768.Extensible Enumerations
• 769.OpenAPI Operation
• 770.OpenAPI comprehensive sample
• 771.OpenAPI language code format