rest-api-conventions SKILL.md skillA
rest-api-conventions from rrezartprebreza/spring-boot-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add rrezartprebreza/spring-boot-skills/rest-api-conventions@git:20261017.a317397Pins git:20261017.a317397 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- rrezartprebreza/spring-boot-skills
- Path
skills/spring-boot-3/rest-api-conventions/SKILL.md- Versions recorded
- 4
- Latest version
- git:20261017.a317397, committed Oct 17, 2026
- First version recorded
- Jul 4, 2026
- Size
- 7,131 bytes
- Repository stars
- 338
- License
- MIT
Use when generating REST controllers, DTOs, success response contracts, pagination, HTTP status mapping, or API versioning. For RFC 9457 exception and error response formatting, use problem-details-rfc9457 unless the project explicitly requires a legacy error envelope.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# REST API Conventions
## Project Contract
Inspect existing controllers, tests and OpenAPI before choosing a response contract.
Preserve the project's IDs, response shape and versioning strategy. Do not migrate unrelated
endpoints while adding one route. The envelope below is an optional convention for a project
that uses it; plain success DTOs are equally valid. A 204 response has no body.
Success and error formats are independent: an existing success envelope can coexist with
RFC 9457 errors. Use one consistent error policy; choose the legacy error examples below only
when the project already requires that format.
Example success envelope:
```json
{
"success": true,
"data": { },
"error": null,
"timestamp": "2026-04-13T10:00:00Z"
}
```
Error response:
```json
{
"success": false,
"data": null,
"error": {
"code": "ORDER_NOT_FOUND",
"message": "Order with id 123 not found",
"details": []
},
"timestamp": "2026-04-13T10:00:00Z"
}
```
## ApiResponse Wrapper
```java
@JsonInclude(JsonInclude.Include.NON_NULL)
public record ApiResponse<T>(
boolean success,
T data,
ApiError error,
Instant timestamp
) {
…Read the whole file at its exact version.
How to install
mdr add rrezartprebreza/spring-boot-skills/rest-api-conventions@sha256:2674cc4f244856b9The line at the top of this page pins the label git:20261017.a317397, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_wrrguptt6r35jmke)
0 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Jul 4, 2026 and Oct 17, 2026, about one every 35 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261017.a317397 latest | 2026-10-17 | a317397 | 7,131 B | A | view · diff |
| git:20260907.13f9ef2 | 2026-09-07 | 13f9ef2 | 5,925 B | A | view · diff |
| git:20260814.237485e | 2026-08-14 | 237485e | 4,915 B | A | view · diff |
| git:20260704.22f1701 | 2026-07-04 | 22f1701 | 4,823 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (7131 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
rrezartprebreza/spring-boot-skills · 338 stars · license MIT · pushed 2026-11-02 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_wrrguptt6r35jmke GET https://markdownregistry.com/api/v1/resolve?ref=rrezartprebreza/spring-boot-skills/rest-api-conventions GET https://markdownregistry.com/api/v1/blob/2674cc4f244856b95d23c3a11f2042d6988bbdcf469404e2efd956dc8bd88c8e
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.