Use it to configure API titles, descriptions, versions, documentation URLs, and the OpenAPI configuration class.

It keeps API documentation discoverable, consistent, and aligned with the routes and authentication requirements.

How lsampaioweb/ai-instructions configures GitHub Copilot

Q: What is ai-instructions spring-boot-openapi.instructions.md?

A set of Spring Boot rules for OpenAPI documentation, the machine-readable description of an HTTP API. It defines stable metadata and paths for the API specification and Swagger UI, a browser-based API reference.

Reuse

Borrowing it

Nothing to install: this file belongs to lsampaioweb/ai-instructions. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/lsampaioweb/ai-instructions/main/.github/instructions/spring-boot-openapi.instructions.md

Clone the repo

git clone --depth 1 https://github.com/lsampaioweb/ai-instructions

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-openapi.svg)](https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-openapi)

Your own site

<a href="https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-openapi"><img src="https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-openapi.svg" alt="Measured on agentmods" height="20"></a>

Per session 507 This file is loaded in full into every session.

When invoked 507 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00507	$0.00507
Opus 5	$0.00253	$0.00253
Sonnet 5	$0.00101	$0.00101
Haiku 4.5	$0.00051	$0.00051

Measured 3d ago against content hash 3827d5144678, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

ai-instructions spring-boot-openapi.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/spring-boot-openapi.instructions.md · 30 lines

What it actually says

Spring Boot OpenAPI Engine

Naming Conventions

Name the OpenAPI configuration class OpenApiConfig.
Name the @Bean method that creates the OpenAPI bean customOpenAPI().
Place OpenApiConfig at the module root or in an openapi sub-package of the feature.

Rules

For springdoc.* property placement rules in application*.yml, defer to spring-boot-config.instructions.md.
Declare exactly one OpenAPI configuration class per runnable module.
Declare OpenApiConfig as a public class.
Set info.title to a concise, human-readable module name.
Set info.version to the current API version in semantic version format (e.g., 1.0.0).
Keep info.version synchronized with the active route version prefix.
Set info.description to a one-paragraph summary covering the module's purpose, base URL, and authentication requirements.
Resolve info.title and info.description from openapi.* message keys via MessageSource injection.
Configure springdoc.swagger-ui.path=/swagger-ui.html in application.yml for a stable, discoverable Swagger UI URL.
Configure springdoc.api-docs.path=/api-docs in application.yml for a stable, discoverable OpenAPI spec URL.
Define springdoc.swagger-ui.path and springdoc.api-docs.path together in the same change.
When an OpenApiConfig component is created or modified, add matching openapi.* keys in all active locale bundles (messages.properties and locale variants) in the same change.
Keep the configured springdoc.swagger-ui.path and springdoc.api-docs.path values consistent across base and profile-specific application*.yml files unless a profile-specific override is explicitly required and documented.
Apply @Tag and @Operation consistently across all touched endpoints when the module adopts per-endpoint documentation.
Keep public schema names and semantics stable.
Document any schema-name or semantics change with a versioning decision in the same change.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

3d ago First seen · 30 lines · 507 tokens per session scan A 3827d5144678

Subscribe to this mod's changes

ai-instructions spring-boot-openapi.instructions.md is an instructions file published in the GitHub repository lsampaioweb/ai-instructions (1 stars, last pushed 14d ago), licensed MIT. It adds 507 tokens to every session, about $0.0025 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Backend and APIs

vibe-coding-prompt-template backend.instructions.md

Instructions for KhazP/vibe-coding-prompt-template: Read AGENTS.md, agentdocs/techstack.md, and agentdocs/codepatterns.md.

KhazP/vibe-coding-prompt-template · 139 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

ai-instructions: Instructions file for GitHub Copilot