701-technologies-openapi

Solid

Use when you need framework-agnostic OpenAPI 3.x guidance — spec structure, metadata and versioning, paths and operations, reusable schemas, security schemes, examples, documentation quality, contract validation (e.g. Spectral), breaking-change awareness, and handoffs to codegen — without choosing Spring Boot, Quarkus, or Micronaut. Part of the skills-for-java project

AI & Automation 393 stars 78 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 91/100

Stars 20%
86
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
96
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# OpenAPI 3.x best practices Help teams produce maintainable **OpenAPI 3.x** contracts that stay aligned with HTTP semantics and consumer needs. **What is covered in this Skill?** - Document structure: `openapi`, `info`, `servers`, `tags`, and consistent resource grouping - Path and operation design: parameters, request bodies, response matrices, `operationId`, status codes - Reusable `components` (schemas, parameters, responses, security schemes) and examples - Validation and CI: spec linting, breaking-change checks, pre-codegen gates - Security modeling in the contract (schemes, scopes, global vs operation security) - Clear boundaries between contract-first design and runtime implementation concerns **Scope:** Contract-first quality only. Focus this skill on OpenAPI design, quality, and governance guidance. ## Constraints Keep recommendations at the OpenAPI layer unless the user explicitly asks for Java framework integration. After editing this repository's XML sources, regenerate skills and verify the build. - **MANDATORY**: Run `./mvnw compile` or `mvn compile` before proposing Java or Maven changes in the same change set - **FRAMEWORK**: Keep guidance contract-centric; do not prescribe framework-specific controller wiring or runtime exposure details - **FUZZING**: Keep fuzzing guidance high-level and contract-focused without linking to external skill identifiers - **MANDATORY**: Regenerate skills with `./mvnw clean install -pl skills-generator` after editing skill...

Details

Author
jabrena
Repository
jabrena/cursor-rules-java
Created
1 years ago
Last Updated
today
Language
Java
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category