moai-domain-web-api

OpenAPI 3.1 is a specification format for documenting REST APIs. Design your REST API by drafting an OpenAPI 3.1 spec that defines your resources, endpoints, request/response schemas, and authentication methods, then use tools like Swagger UI or Postman to validate and visualize the spec.

REST API authentication includes schemes like OAuth, API keys, and Bearer tokens defined in your OpenAPI spec. Versioning strategies include URL path versioning (v1/v2) or header-based versioning; apply these consistently across all endpoints and document them in your OpenAPI 3.1 specification.

OpenAPI 3.1 primarily documents REST APIs, but this Skill provides GraphQL design patterns alongside REST best practices. You can design GraphQL schemas with type definitions and resolvers following similar architectural principles for security, versioning, and rate limiting.

Implement rate limiting by defining rate-limit policies in your API gateway or middleware, documenting them in your OpenAPI spec. Apply TDD workflows by writing test cases before implementing endpoints, ensuring your API meets security and versioning requirements before deployment.

Yes, OpenAPI 3.1 specifications are fully compatible with Postman and Swagger UI. Import your OpenAPI spec into either tool to generate interactive API documentation, enable testing, and validate request/response contracts across teams.

Define versioning strategies in your OpenAPI 3.1 specification—either URL-based, header-based, or content-negotiation approaches—and enforce them consistently across all deployments. Document deprecation policies and migration paths for teams transitioning between API versions.