api-expert

Architect secure API systems with RESTful conventions and OpenAPI 3.1 standards.

2|Updated Dec 4, 2022

Search Tags:#architecture #security #api #openapi #owasp #rest

Ready to run

npx skills add https://github.com/alexrf45/SCRT --skill api-expert-alexrf45

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-expert
Source: https://github.com/alexrf45/SCRT/tree/main/.claude/skills/api-expert
Command: npx skills add https://github.com/alexrf45/SCRT --skill api-expert-alexrf45

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill eliminates the risk of architectural flaws, security vulnerabilities, and inconsistent design patterns when building complex RESTful, GraphQL, or gRPC APIs.

Core Features & Use Cases

Security-First Design: Implements OWASP API Security Top 10 mitigations, including BOLA protection and rate limiting.
Standardized Architecture: Enforces RESTful conventions, RFC 7807 error handling, and OpenAPI 3.1 contract-driven development.
Use Case: When designing a new user management service, use this Skill to generate a secure OpenAPI specification, define robust authentication middleware, and establish efficient cursor-based pagination strategies.

Quick Start

Use the api-expert skill to design a secure RESTful endpoint for user profile updates that includes input validation and BOLA protection.

Frequently Asked Questions about api-expert

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

FAQPage Schema

How do I design a REST API that protects against BOLA vulnerabilities?▼

To protect against BOLA in a REST API, enforce object-level authorization checks on every endpoint. This Skill architects secure APIs by applying OWASP API Security Top 10 mitigations, including strict BOLA protection and rate limiting.

What's the best way to standardize REST API error handling?▼

The best way to standardize REST API error handling is using RFC 7807. This Skill enforces RFC 7807 error handling alongside OpenAPI 3.1 contract-driven development to ensure consistent error responses.

How do I implement cursor-based pagination in an OpenAPI specification?▼

Cursor-based pagination in an OpenAPI specification requires defining cursor parameters and next-page tokens. This Skill architects scalable API systems by establishing efficient cursor-based pagination strategies within OpenAPI 3.1 standards.

Can I use this to architect GraphQL and gRPC services, or is it limited to REST?▼

You can use this to architect GraphQL and gRPC services, not just REST. It applies to the design, implementation, and documentation phases of REST, GraphQL, and gRPC service development, enforcing secure and scalable conventions.

When do I need OpenAPI 3.1 contract-driven development for my API?▼

You need OpenAPI 3.1 contract-driven development when building complex APIs to eliminate architectural flaws and inconsistent design patterns. This Skill enforces OpenAPI 3.1 standards to satisfy technical requirements for robust authentication and documentation.