Hier ist die Definition einer API für die Verwaltung von TODO-Listen.
```
openapi: 3.0.1
info:
title: TODO Plugin
description: Ein Plugin, das es dem Benutzer ermöglicht, eine TODO-Liste mithilfe von ChatGPT zu erstellen und zu verwalten. Wenn Sie den Benutzernamen des Benutzers nicht kennen, fragen Sie zuerst danach, bevor Sie Abfragen für das Plugin durchführen. Andernfalls verwenden Sie den Benutzernamen "global".
version: 'v1'
servers:
- url: http://localhost:5003
paths:
/todos/{username}:
get:
operationId: getTodos
summary: Holen Sie sich die Liste der TODOs
parameters:
- in: path
name: username
schema:
type: string
required: true
description: Der Name des Benutzers.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getTodosResponse'
post:
operationId: addTodo
summary: Fügen Sie der Liste ein TODO hinzu
parameters:
- in: path
name: username
schema:
type: string
required: true
description: Der Name des Benutzers.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/addTodoRequest'
responses:
"200":
description: OK
delete:
operationId: deleteTodo
summary: Löschen Sie ein TODO von der Liste
parameters:
- in: path
name: username
schema:
type: string
required: true
description: Der Name des Benutzers.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/deleteTodoRequest'
responses:
"200":
description: OK
components:
schemas:
getTodosResponse:
type: object
properties:
todos:
type: array
items:
type: string
description: Die Liste der TODOs.
addTodoRequest:
type: object
required:
- todo
properties:
todo:
type: string
description: Das TODO, das zur Liste hinzugefügt werden soll.
required: true
deleteTodoRequest:
type: object
required:
- todo_idx
properties:
todo_idx:
type: integer
description: Der Index des TODO, das gelöscht werden soll.
required: true
```
Ich möchte mit dieser API ein TODO mit der Beschreibung „Kaufe die Milch“ hinzufügen. Was ist der Körper der Anfrage, die ich senden sollte?
Schlüsselwörter
- Software Entwicklung
- Codierung
- Projektmanagement
- Produktivität Werkzeuge
- Aufgabenverwaltung
- Api Nutzung
- Chat GPT Plugin
- Aufgabenverfolgung
- Offene API-Dokumentation
Quelle