README

安装

composer require jastrzebski/swaggier

描述

它通过向选定的 RestApi 发送请求来构建 OpenApi 3.0.0 文档。仅支持 JSON 格式（响应）并提供 GET、POST、PUT、PATCH 和 DELETE HTTP 请求。

用法

基本

首先，您需要构建一个类似于以下结构的 JSON 请求模式

[
  {
    "url": "https://:3000",
    "endpoint": "/test/{id}",
    "method": "get",
    "headers": [
      "Content-type: application/json"
    ],
    "parameters": {
      "id": 1
    }
  },
  {
    "url": "https://:3000",
    "endpoint": "/test",
    "method": "get",
    "headers": [
      "Content-type: application/json"
    ]
  },
  {
    "url": "https://:3000",
    "endpoint": "/test",
    "method": "post",
    "headers": [
      "Content-type: application/json"
    ],
    "request": {
      "name": "Marek",
      "surname": "Jastrzebski",
      "age": 33,
      "luckyNumber": 0.23,
      "others": {
        "hobby" : ["reading", "cleaning"],
        "programingLangs": {
          "php": true,
          "Java": false
        },
        "badname": "phr"
      }
    }
  }
]

请求元素

url

请传递 URL，无需端点，地址末尾不要有斜杠。

endpoint

请传递端点，如果您想传递任何参数，请将其名称放在大括号 {} 中。

method

请设置您要用于发送此请求的方法。

headers

请传递您想随请求一起发送的所有头部。始终将其设置为数组。

参数（可选）

仅在您想将参数传递到查询（URL）中时设置此元素。名称必须与查询相同。

request（可选）

请传递 JSON 请求体

运行

如果您想从 request.json 运行严格请求，请使用此命令

vendor/bin/swaggier -r=request.json

它将输出包含 OpenApi 3.0 描述的 swaggier.json 文件。

但如果您想运行一些可以生成其他响应的替代场景

vendor/bin/swaggier -r=request.json -b=true

它将运行“原始”、“无头部”、“无请求”、“类型转换”场景

jastrzebski / swaggier

维护者

详细信息