spring-api-design

Name: spring-api-design
Author: CrediScan-UdeA-FabricaEscuela

Spring API Design Rules

by CrediScan-UdeA-FabricaEscuela(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from CrediScan-UdeA-FabricaEscuela/crediscan-backend (.github/instructions/spring-api-design.instructions.md). Copyright stays with the author.

Spring API Design Rules

Mandatory rules

Never expose entities in API responses; use explicit request/response DTOs.
Validate all mutable request payloads (@Valid, bean validation annotations).
Keep endpoint naming resource-oriented and versioned (/api/v1/...).
Return standardized errors using RFC 7807 ProblemDetail style.
Add OpenAPI annotations for public endpoints and DTO schemas.

Response design

Include navigational links when applicable (HATEOAS style).
Keep status code semantics strict: 400, 401, 403, 404, 409, 422, 500.

Anti-patterns

No business logic in controllers.
No generic Exception messages leaked to clients.
No undocumented endpoints or undocumented error contracts.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/crediscan-udea-fabricaescuela-crediscan-backend-spring-a-601c06/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

crediscan-udea-fabricaescuela-crediscan-backend-spring-a-601c06.ocm.jsonjson

{
  "ocm": "1",
  "id": "crediscan-udea-fabricaescuela-crediscan-backend-spring-a-601c06",
  "kind": "skill",
  "name": "spring-api-design",
  "description": "Spring API Design Rules",
  "publisher": "CrediScan-UdeA-FabricaEscuela",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Spring API Design Rules"
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/CrediScan-UdeA-FabricaEscuela/crediscan-backend",
      "path": ".github/instructions/spring-api-design.instructions.md",
      "ref": "bea0bd7385047a572cfd4e35377efd04d82ddba3",
      "url": "https://github.com/CrediScan-UdeA-FabricaEscuela/crediscan-backend/blob/bea0bd7385047a572cfd4e35377efd04d82ddba3/.github/instructions/spring-api-design.instructions.md",
      "key": "CrediScan-UdeA-FabricaEscuela/crediscan-backend/.github/instructions/spring-api-design.instructions.md"
    },
    "applies_to": "src/main/java/co/udea/codefactory/creditscoring/**/*Controller.java,src/main/java/co/udea/codefactory/creditscoring/**/application/dto/**/*.java,src/main/java/co/udea/codefactory/creditscoring/**/infrastructure/adapter/in/rest/**/*.java"
  },
  "instructions": "# Spring API Design Rules\n\n## Mandatory rules\n- Never expose entities in API responses; use explicit request/response DTOs.\n- Validate all mutable request payloads (`@Valid`, bean validation annotations).\n- Keep endpoint naming resource-oriented and versioned (`/api/v1/...`).\n- Return standardized errors using RFC 7807 `ProblemDetail` style.\n- Add OpenAPI annotations for public endpoints and DTO schemas.\n\n## Response design\n- Include navigational links when applicable (HATEOAS style).\n- Keep status code semantics strict: 400, 401, 403, 404, 409, 422, 500.\n\n## Anti-patterns\n- No business logic ",
  "cost": {
    "context_tokens": 182
  }
}

Fetch it by URL: GET /api/v1/registry/crediscan-udea-fabricaescuela-crediscan-backend-spring-a-601c06/manifest?version=1.0.0

About

Spring API Design Rules

Mandatory rules

Response design

Anti-patterns

Use it

Manifest

Reviews