以下為透過 OpenAPI 簡易實現一個 To-Do List 的 Example (openapi.yaml)。
程式碼區塊 | ||
---|---|---|
| ||
openapi: 3.0.1 info: title: TODO Plugin description: A plugin that allows the user to create and manage a TODO list using ChatGPT. If you do not know the user's username, ask them first before making queries to the plugin. Otherwise, use the username "global". version: 'v1' servers: - url: http://localhost:5003 paths: /todos: get: operationId: getTodos summary: Get the list of todos responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/getTodosResponse' post: operationId: addTodo summary: Add a todo to the list requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/addTodoRequest' responses: "200": description: OK delete: operationId: deleteTodo summary: Delete a todo from the list 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: The list of todos. addTodoRequest: type: object required: - todo properties: todo: type: string description: The todo to add to the list. required: true deleteTodoRequest: type: object required: - todo_idx properties: todo_idx: type: integer description: The index of the todo to delete. -1 for delete all todos required: true |
參考資料
...