--- name: backend-api-standards-77186b618418 description: Design and implement RESTful API endpoints following REST principles with proper HTTP methods, status codes, and resource-based URLs. Use this skill when creating or modifying API endpoints, route handlers, controllers, or API configuration files. Apply when working on REST API design, endpoint implementations, API versioning, request/response handling, HTTP method routing (GET, POST, PUT, PATCH, DELETE), query parameter filtering, API rate limiting, or any file that defines API routes such as routes.py, api.js, controllers/, endpoints/, or API documentation files. --- # Backend API Standards Apply these standards when creating or modifying API endpoints, route handlers, and controllers. ## When to use this skill - When creating or modifying API endpoint files (routes.py, api.js, controllers/, endpoints/, etc.) - When implementing REST API route handlers and controllers - When designing resource-based URL structures and HTTP method routing - When working with API versioning strategies in URL paths or headers - When implementing query parameters for filtering, sorting, pagination, or search - When configuring HTTP status codes for API responses - When setting up rate limiting headers or API middleware - When writing API documentation or OpenAPI/Swagger specifications - When refactoring existing API endpoints for consistency or REST compliance This Skill provides Claude Code with specific guidance on how to adhere to coding standards as they relate to how it should handle backend API. ## RESTful Design Principles **Resource-based URLs with HTTP methods:** - `GET /users` - List users - `GET /users/{id}` - Get specific user - `POST /users` - Create user - `PUT /users/{id}` - Replace user (full update) - `PATCH /users/{id}` - Update user (partial update) - `DELETE /users/{id}` - Delete user **Use plural nouns for collections:** - ✅ `/users`, `/products`, `/orders` - ❌ `/user`, `/product`, `/order` **Limit nesting to 2-3 levels:** - ✅ `/users/{id}/orders` - ✅ `/users/{id}/orders/{order_id}` - ❌ `/users/{id}/orders/{order_id}/items/{item_id}/reviews` ## URL and Naming Conventions **Consistent casing:** - Use lowercase with hyphens: `/user-profiles` or underscores: `/user_profiles` - Never mix: ❌ `/userProfiles`, ❌ `/User-Profiles` - Check existing endpoints first and match the project's convention **Query parameters for operations:** - Filtering: `GET /users?status=active&role=admin` - Sorting: `GET /users?sort=created_at&order=desc` - Pagination: `GET /users?page=2&limit=50` or `?offset=100&limit=50` - Search: `GET /users?q=john` **Avoid creating separate endpoints for these operations.** ## HTTP Status Codes Return accurate status codes: **Success:** - `200 OK` - Successful GET, PUT, PATCH, DELETE - `201 Created` - Successful POST (include `Location` header) - `204 No Content` - Successful DELETE with no response body **Client Errors:** - `400 Bad Request` - Invalid input, validation failure - `401 Unauthorized` - Missing or invalid authentication - `403 Forbidden` - Authenticated but not authorized - `404 Not Found` - Resource doesn't exist - `409 Conflict` - Duplicate resource, constraint violation - `422 Unprocessable Entity` - Semantic validation failure **Server Errors:** - `500 Internal Server Error` - Unexpected server error - `503 Service Unavailable` - Temporary unavailability ## API Versioning **Choose one strategy and apply consistently:** URL path versioning (recommended for simplicity): ``` /v1/users /v2/users ``` Header versioning (for cleaner URLs): ``` Accept: application/vnd.api.v1+json ``` **When to version:** - Breaking changes to request/response format - Removing fields or endpoints - Changing field types or validation rules **Don't version for:** - Adding optional fields - Adding new endpoints - Bug fixes ## Request/Response Patterns **Consistent response structure:** ```json { "data": { "id": 1, "name": "John" }, "meta": { "timestamp": "2024-01-01T00:00:00Z" } } ``` **Error response structure:** ```json { "error": { "code": "VALIDATION_ERROR", "message": "Invalid input", "details": [{ "field": "email", "message": "Invalid email format" }] } } ``` **Pagination metadata:** ```json { "data": [...], "pagination": { "page": 2, "limit": 50, "total": 250, "pages": 5 } } ``` ## Rate Limiting **Include rate limit headers:** ``` X-RateLimit-Limit: 1000 X-RateLimit-Remaining: 999 X-RateLimit-Reset: 1640995200 ``` Return `429 Too Many Requests` when limit exceeded. ## Validation and Error Handling **Validate at API boundary:** - Check required fields before processing - Validate formats (email, phone, URL) - Enforce business rules - Return specific error messages **Never expose internal errors to clients:** - ❌ Database error messages - ❌ Stack traces - ❌ Internal file paths - ✅ Generic "Internal server error" with request ID for tracking ## Documentation **Document each endpoint:** - Purpose and use case - Request parameters and body schema - Response schema and status codes - Authentication requirements - Rate limits - Example requests/responses Use OpenAPI/Swagger for machine-readable documentation. ## Before Completing API Work - [ ] Endpoints follow REST principles - [ ] URLs use consistent naming convention - [ ] HTTP methods match operations (GET for read, POST for create, etc.) - [ ] Status codes accurately reflect responses - [ ] Validation happens at API boundary - [ ] Error responses are structured and specific - [ ] Rate limiting headers included (if applicable) - [ ] Documentation updated - [ ] Tests cover success and error cases --- Source attribution: David-Li0406 Original project: https://github.com/David-Li0406/meta-skill-evloving/blob/ca3a335628981df10c36e00cb9850df2c247ab9a/skill-flow/data/skills-refined-36k/skillsmp/backend-api-standards/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: David-Li0406 Original project: https://github.com/David-Li0406/meta-skill-evloving/blob/ca3a335628981df10c36e00cb9850df2c247ab9a/skill-flow/data/skills-refined-36k/skillsmp/backend-api-standards/SKILL.md Attribution basis: Source repository record Fields of work: Data & Analytics, Development & Engineering, Product Management Roles: Backend Developer, Data Analyst, Full-Stack Developer, Product Manager, Technical Product Manager Specialties: API, Backend Tools: Swagger Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 7c17a92458d2dc18ec9342418b5cc54e27e4099cdf8c0f40139e09e60bb7fcd1