LaravelGPT

LaravelGPT · GPT アクション

GPT Laravel Documentation API

  • GET /api/laravel/all-versionsGet available Laravel documentation versions
  • GET /api/laravel/Get documentation modules for the latest version of Laravel.
  • GET /api/laravel/{version}Get documentation modules for a specified version of Laravel.
  • GET /api/laravel/documentation/{documentation_id}Get specific documentation content by ID
元の API スキーマ
{
  "openapi": "3.0.0",
  "info": {
    "title": "GPT Laravel Documentation API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://gptdocs.dev"
    }
  ],
  "paths": {
    "/api/laravel/all-versions": {
      "get": {
        "summary": "Get available Laravel documentation versions",
        "operationId": "getAvailableVersions",
        "responses": {
          "200": {
            "description": "A list of available Laravel versions",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "repository": {
                      "type": "string"
                    },
                    "available_versions": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/laravel/": {
      "get": {
        "summary": "Get documentation modules for the latest version  of Laravel.",
        "operationId": "getDocumentationModulesForLatestVersion",
        "responses": {
          "200": {
            "description": "A list of modules for the latest Laravel version",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LaravelModules"
                }
              }
            }
          }
        }
      }
    },
    "/api/laravel/{version}": {
      "get": {
        "summary": "Get documentation modules for a specified version of Laravel.",
        "operationId": "getDocumentationModulesForSpecificVersion",
        "parameters": [
          {
            "in": "path",
            "name": "version",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The version of Laravel."
          }
        ],
        "responses": {
          "200": {
            "description": "A list of modules for the specified Laravel version",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LaravelModules"
                }
              }
            }
          }
        }
      }
    },
    "/api/laravel/documentation/{documentation_id}": {
      "get": {
        "summary": "Get specific documentation content by ID",
        "operationId": "getDocumentationById",
        "parameters": [
          {
            "in": "path",
            "name": "documentation_id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Documentation content for the given ID",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "repository": {
                      "type": "string"
                    },
                    "version": {
                      "type": "string"
                    },
                    "module": {
                      "type": "string"
                    },
                    "topic": {
                      "type": "string"
                    },
                    "documentation": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "LaravelModules": {
        "type": "object",
        "properties": {
          "repository": {
            "type": "string"
          },
          "version": {
            "type": "string"
          },
          "modules": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "topics": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "subtopics": {
                        "type": "string"
                      },
                      "documentation_id": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}