API Engineering

knowledge skill

Designs, documents, and implements RESTful or GraphQL APIs from an OpenAPI/Swagger specification. Produces a runnable API server artifact (e.g., FastAPI app) and an OpenAPI document that matches the implementation.

Worked examples

• {"input": {"spec": "openapi: 3.0.0\ninfo:\n title: PetStore\n version: 1.0.0\npaths:\n /pets:\n get:\n responses:\n '200':\n description: OK", "server_type": "fastapi", "base_url": "http://localhost:8000"}, "output": {"server_artifact": "from fastapi import FastAPI; app = FastAPI(); @app.get('/pets') ...", "openapi_doc": "openapi: 3.0.0\ninfo:\n title: PetStore\n version: 1.0.0\npaths:\n /pets:\n get:\n responses:\n '200':\n description: OK", "status": "implemented"}}
• {"input": {"spec": "openapi: 3.0.3\ninfo:\n title: UserAPI\n version: 2.1.0\npaths:\n /users:\n post:\n requestBody:\n content:\n application/json:\n schema:\n type: object", "server_type": "flask", "base_url": "https://api.example.com"}, "output": {"server_artifact": "@app.route('/users', methods=['POST']) def create_user() ...", "openapi_doc": "openapi: 3.0.3\ninfo:\n title: UserAPI\n version: 2.1.0\npaths:\n /users:\n post:\n requestBody:\n content:\n application/json:\n schema:\n type: object", "status": "flask_server_generated"}}

Input

• spec: string
• server_type: string
• base_url: string

Output

• server_artifact: string
• openapi_doc: string
• status: string

Details

• Skill type: knowledge skill
• Safety level: safe_public_research
• Version: 1.0.0