Run any Skill in Manus with one click

api-design

Stars26

Forks4

UpdatedMarch 30, 2026 at 02:57

REST API design guide for new endpoints — RESTful URL structure, query parameter binding rules (@RequestParam vs @ModelAttribute), OpenAPI annotations, and CommonApiResponse usage.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Run Skill in Manus

Source

themoment-team

themoment-team/datagsm-server

View GitHub Repository View Creator Repositories

Download

Run Skill in Manus

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

SKILL.md

readonly

name	api-design
description	REST API design guide for new endpoints — RESTful URL structure, query parameter binding rules (@RequestParam vs @ModelAttribute), OpenAPI annotations, and CommonApiResponse usage.

REST API Design Guide

URL Design

RESTful principles: /v1/auth/api-keys
Use plural: /students, /clubs
Hierarchy: /students/{id}/projects

Query Parameters

Filtering: ?status=active
Pagination: ?page=0&size=20
Sorting: ?sort=createdAt,desc

OpenAPI Documentation

@Operation(summary = "Create API key", description = "...")
@ApiResponse(responseCode = "200", description = "Success")
@PostMapping("/api-keys")
fun create(@Valid @RequestBody reqDto: CreateApiKeyReqDto): CommonApiResponse<ApiKeyResDto>

Response Format

Success: CommonApiResponse(data = ...)
Error: ExpectedException → Global Handler

More from this repository

same repository

the-sdk

themoment-team/datagsm-server

Usage guide for the-sdk common library — HTTP request/response logging with UUID Log-ID, CommonApiResponse wrapping, ExpectedException handling, and Swagger auto-configuration.

2026-06-2326

database-schema

themoment-team/datagsm-server

Database schema design guide — table naming, column conventions, index strategy, and JPA entity mapping patterns.

2026-05-2726

docker

themoment-team/datagsm-server

Dockerfile and docker-compose authoring guide — multi-stage builds, layer caching, security best practices, and compose service wiring.

2026-05-2726

database-schema

themoment-team/datagsm-server

Database schema design guide — table naming, column conventions, index strategy, and JPA entity mapping patterns.

2026-05-2726

planning

themoment-team/datagsm-server

Conduct an in-depth structured interview with the user to uncover non-obvious requirements, tradeoffs, and constraints, then produce a detailed implementation spec file.

2026-05-2726

planning

themoment-team/datagsm-server

Conduct an in-depth structured interview with the user to uncover non-obvious requirements, tradeoffs, and constraints, then produce a detailed implementation spec file.

2026-05-2626

name	api-design
description	REST API design guide for new endpoints — RESTful URL structure, query parameter binding rules (@RequestParam vs @ModelAttribute), OpenAPI annotations, and CommonApiResponse usage.

REST API Design Guide

URL Design

RESTful principles: /v1/auth/api-keys
Use plural: /students, /clubs
Hierarchy: /students/{id}/projects

Query Parameters

Filtering: ?status=active
Pagination: ?page=0&size=20
Sorting: ?sort=createdAt,desc

OpenAPI Documentation

@Operation(summary = "Create API key", description = "...")
@ApiResponse(responseCode = "200", description = "Success")
@PostMapping("/api-keys")
fun create(@Valid @RequestBody reqDto: CreateApiKeyReqDto): CommonApiResponse<ApiKeyResDto>

Response Format

Success: CommonApiResponse(data = ...)
Error: ExpectedException → Global Handler