Use it to design a REST service from scratch or establish a missing shared contract.
A RESTful API design and development guide co
A developer guide to seven API Development Skills for contract design, authorization and compatibility testing, and documentation handoff. Keep design, implementation, tests, and consumer guidance aligned to one reviewed contract.
API Development Skills help an agent turn natural-language requirements into an interface contract, then connect authorization, error semantics, implementation checks, tests, and documentation. They support repeatable work from resource modelling to consumer onboarding, but they do not replace an API owner's decisions about data access, backward compatibility, versioning, or release risk.
| Use case | Primary role |
|---|---|
| Contract and interface design | Write resources, methods, parameters, responses, errors, and versioning as a reviewable interface contract before implementation begins. This group helps service owners and consumers agree on behaviour early enough to avoid repeated redesign during development. |
| Testing, authorization, and compatibility | Build a validation matrix for authorization, excessive access, failures, idempotency, rate limits, performance, and backward compatibility. These Skills belong in an isolated environment where both the happy path and the contract boundaries can be proven. |
| Documentation and delivery | Generate reference documentation, working examples, change notes, and migration guidance from the verified contract, then detect implementation drift in CI. This group makes the API understandable and safer for consumers to adopt. |
This guide covers seven API Development Skills. Contract Skills establish shared behaviour, validation Skills test success and failure boundaries, and documentation Skills keep implementation aligned with consumer guidance; developers can sequence them around one reviewed contract.
DeepSkill organises interface contracts, authorization and compatibility testing, and documentation handoff into installable API Development Skills that can be selected by delivery stage. These seven Skills cover design, validation, and consumer guidance; keep every trial aligned to one reviewed contract and compare completeness, validation depth, and release risk.
Write resources, methods, parameters, responses, errors, and versioning as a reviewable interface contract before implementation begins. This group helps service owners and consumers agree on behaviour early enough to avoid repeated redesign during development.
Use it to design a REST service from scratch or establish a missing shared contract.
A RESTful API design and development guide co
Use it when resource, versioning, authorization, or pagination trade-offs need a design decision.
An API service design method covering REST co
Use it before release to review an existing OpenAPI contract against implementation expectations.
Statically checks an OpenAPI or Swagger defin
Build a validation matrix for authorization, excessive access, failures, idempotency, rate limits, performance, and backward compatibility. These Skills belong in an isolated environment where both the happy path and the contract boundaries can be proven.
Use it when an API specification exists but its high-risk test matrix is incomplete.
Creates a comprehensive API test-analysis doc
Choose it when basic API checks must expand into security, performance, and compatibility.
Plans API tests across functional, security,
Generate reference documentation, working examples, change notes, and migration guidance from the verified contract, then detect implementation drift in CI. This group makes the API understandable and safer for consumers to adopt.
Use it after the contract stabilises to explain integration and failure handling to consumers.
An API documentation assistant for writing RE
Use it before release when endpoint, parameter, error, and authentication reference is incomplete.
Generates API documentation with methods, pat
DeepSkill indexes 400K+ Skills, and every Skill undergoes security review and risk validation. Search by API stage: contract design, resource modelling, authorization tests, compatibility checks, documentation, or migration handoff. Include the protocol, resource model, authentication, existing consumers, and non-breaking boundaries so the returned Skills close the current delivery gap.
Enter the protocol, resource model, authentication, existing consumers, data sensitivity, and release constraints. Include paths, fields, and error semantics that must remain backward compatible.
Separate candidates for contract design, authorization and compatibility tests, and documentation handoff. Then inspect credentials, external access, and files they modify, and do not let several Skills rewrite the contract independently.
Copy one command and trial it in an isolated environment against the same reviewed contract. Use short-lived, least-privilege credentials and validate success, failure, and compatibility from a consumer's perspective.
Send the instruction below if you want your agent to find Skills during a task. Once installed, DeepSkill can search for and install Skills that match the current task. The instruction works with mainstream agents such as Codex, Claude Code, and WorkBuddy.
Install DeepSkill according to https://www.deepskill.market/deepskill.md.Define resources, paths, parameters, success and failure responses, the authorization matrix, and versioning before implementation. Use an isolated environment, short-lived credentials, and least privilege for tests, and validate error semantics, idempotency, pagination, rate limits, and compatibility in addition to the happy path.
Specify resources, methods, parameters, responses, errors, and versioning before self-ent-tech-api-builder touches implementation.
List existing clients, auth, traffic, data sensitivity, and fields that cannot break so design is not server-centred.
Use an isolated environment and short-lived credentials. Ask qa-api-testing to cover missing, excessive, expired, and replayed access.
Verify error semantics, backward compatibility, idempotency, pagination boundaries, and rate limiting as well as the happy path.
Roll back through a new version, feature flag, or compatibility layer; preserve migration and deprecation notes.
Use api-doc-writer or api-doc-generator-new from the checked contract, and detect implementation drift in CI.
API Development Skills can connect requirements, implementation, validation, and documentation in one delivery chain when every stage works from the same reviewed contract. Use a design Skill to establish resources, responses, and versioning; use testing Skills to verify authorization, errors, idempotency, and compatibility; then generate consumer-facing documentation and examples from the verified contract. When several Skills are sequenced, do not let each one reinterpret the requirement independently—the contract is the source of truth. Preserve the old route, a feature flag, or a compatibility layer for breaking changes, and keep data access, migration, and release decisions with the API owner so faster delivery remains reversible.
Explore more useful Skills on DeepSkillThe seven candidates cover contract and design, authorization and compatibility testing, and documentation handoff. Start with the current delivery gap.
Yes, but first create and review an equivalent contract covering paths, parameters, responses, errors, auth, and versioning.
Design and documentation usually do not. Testing should use an isolated environment, short-lived credentials, and least privilege, never production secrets.
Cross-check it against the contract, consumer tests, authorization matrix, and error model, and run documentation examples in a test environment.
Yes, sequence contract design, implementation checks, tests, and docs, with one reviewed contract as the source of truth.
Keep the old contract and route, roll back through versioning, a feature flag, or a compatibility layer, and revise the migration plan.