# design-rest-api

> Design RESTful API architecture with comprehensive endpoints, authentication, and documentation

- Source: https://doutorai.pt/en/components/commands__design-rest-api
- Type: Commands
- Category: Setup
- Downloads: 266
- Site: Doutor AI (https://doutorai.pt/en) - AI tools for small businesses

An open-source community component, curated and adapted by Doutor AI.

## What it does and how to use it

A **/slash command**, ready to use, that runs a setup workflow in a single step.

1. Install the command (command above).
2. In Claude Code, type "/" followed by the command name.
3. Follow the instructions the command asks for and let it run.

## Install (Claude Code)

```bash
mkdir -p .claude/commands && curl -fsSL https://doutorai.pt/data/lib/commands__design-rest-api.md -o .claude/commands/design-rest-api.md
```

Paste this command into the terminal, in your project folder, and the component installs automatically.

## Content

```
---
allowed-tools: Read, Write, Edit, Bash
argument-hint: [api-version] | --v1 | --v2 | --graphql-hybrid | --openapi
description: Design RESTful API architecture with comprehensive endpoints, authentication, and documentation
---

# Design REST API

Design comprehensive RESTful API architecture: **$ARGUMENTS**

## Current Application State

- Framework detection: @package.json or @requirements.txt (Express, FastAPI, Spring Boot, etc.)
- Existing API: !`grep -r "route\|endpoint\|@app\\.route" src/ 2>/dev/null | wc -l` routes found
- Authentication: !`grep -r "auth\|jwt\|session" src/ 2>/dev/nul

- 🔒 Full content on the Pro plan (€7.99/month) -
```

## Related components

- [act](https://doutorai.pt/en/components/commands__act): Execute GitHub Actions locally using act
- [add-authentication-system](https://doutorai.pt/en/components/commands__add-authentication-system): Implement secure user authentication system with chosen method and security best practices
- [add-changelog](https://doutorai.pt/en/components/commands__add-changelog): Generate and maintain project changelog with Keep a Changelog format
- [add-mutation-testing](https://doutorai.pt/en/components/commands__add-mutation-testing): Setup comprehensive mutation testing with framework selection and CI integration
- [add-package](https://doutorai.pt/en/components/commands__add-package): Add and configure new package to workspace with proper structure and dependencies
- [add-performance-monitoring](https://doutorai.pt/en/components/commands__add-performance-monitoring): Setup comprehensive application performance monitoring with metrics, alerting, and observability

## Save hours every week with AI, no hassle

**Doutor AI** gives you 1,859 ready-to-copy AI prompts, by industry and in plain English - plus a complete technical library for those who want to go further. [See plans →](https://doutorai.pt/en/pricing)

---
Content by Doutor AI (https://doutorai.pt/en). When quoting, please cite the source: https://doutorai.pt/en/components/commands__design-rest-api