skills.rest
onejaejae
onejaejaeCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-conventions

Defines REST API standards for routing, methods, responses, and SwiftUI views.

2|Updated Feb 27, 2026
Search Tags:#design#api#restful#fastapi#conventions#http
One-click install
npx skills add https://github.com/onejaejae/skills --skill api-conventions-onejaejae
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-conventions
Source: https://github.com/onejaejae/skills/tree/main/plugins/ai-registry/common/workflow-bundle/skills/api-conventions
Command: npx skills add https://github.com/onejaejae/skills --skill api-conventions-onejaejae

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides a clear, standardized set of conventions for designing and implementing RESTful APIs, ensuring consistency, maintainability, and developer efficiency.

Core Features & Use Cases

  • URL Design: Defines best practices for structuring API endpoints.
  • HTTP Methods & Status Codes: Specifies appropriate usage of HTTP verbs and status codes for common operations.
  • Response & Error Formatting: Outlines consistent formats for successful responses and error reporting.
  • Use Case: When building a new microservice, use this Skill's conventions to define all API endpoints, ensuring they align with established patterns for easier integration and understanding by other teams.

Quick Start

Use the api-conventions skill to define the URL structure and HTTP methods for a new resource.

Frequently Asked Questions about api-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the standard RESTful API conventions for structuring URLs and HTTP methods?▼

Standard RESTful API conventions define best practices for structuring endpoint URLs and specify appropriate usage of HTTP verbs for common operations. They ensure consistent resource routing and predictable client-server interactions.

How do I standardize response and error formats in a FastAPI application?▼

To standardize response and error formats in FastAPI, apply consistent conventions for successful responses and error reporting. This involves outlining standardized formats for controllers, services, and schemas to ensure maintainability.

Which HTTP status codes should I use for my RESTful API operations?▼

RESTful API conventions specify appropriate HTTP status codes for common operations, ensuring accurate response signaling. Correct status code usage helps clients handle successful requests and errors predictably across microservices.

How do I implement controllers and schemas in FastAPI following design conventions?▼

Implementing controllers and schemas in FastAPI follows guided conventions that enforce RESTful API design. This ensures adherence to best practices for API development and documentation while structuring endpoints consistently.

Can I use these API design conventions for a new microservice?▼

Yes, you can use these API design conventions for a new microservice. They define all API endpoints to align with established patterns, ensuring easier integration and understanding by other teams.

Related Skills

Explore More Software Engineering Skills→
xvawlxvawl
1

api-design-patterns

Design FastAPI API contracts with endpoints, schemas, pagination, and error formats.

Community
Advanced
giuseppe-trisciuogliogiuseppe-trisciuoglio
322

spring-boot-openapi-documentation

Generate OpenAPI 3.0 documentation and Swagger UI for Spring Boot 3.x applications.

Community
Advanced
DexploarerDexploarer
6

fastapi-generator

Generate FastAPI endpoints with Pydantic schemas and OpenAPI documentation.

Community
Advanced
Camilo8902Camilo8902

rest-to-graphql-migrator

Migrate REST APIs to GraphQL incrementally using schema stitching and REST data source wrappers.

Community
Advanced