Server
话题列表 社区 Wiki 优质外文 招聘求职 Server 实战教程 社区文档
登录
注册

yapi接口管理工具使用

全网第一菜鸡 的个人博客 / 51 / 1 / 创建于 3个月前

一 官网地址

yapi.pro/

二 首先先进行登录或者注册

选择添加项目

yapi接口管理工具使用

yapi接口管理工具使用

示例接口,可以直接导入

[
  {
    "index": 0,
    "name": "分类相关接口",
    "desc": "Category Controller",
    "add_time": 1656056920,
    "up_time": 1656056920,
    "list": [
      {
        "query_path": {
          "path": "/admin/category",
          "params": []
        },
        "edit_uid": 0,
        "status": "undone",
        "type": "static",
        "req_body_is_json_schema": true,
        "res_body_is_json_schema": true,
        "api_opened": false,
        "index": 0,
        "tag": [
          "分类相关接口"
        ],
        "_id": 323246,
        "method": "PUT",
        "title": "修改分类",
        "path": "/admin/category",
        "req_params": [],
        "req_body_form": [],
        "req_headers": [
          {
            "required": "1",
            "_id": "62b571353e1263907bf1feff",
            "name": "Content-Type",
            "value": "application/json"
          }
        ],
        "req_query": [],
        "req_body_type": "json",
        "res_body_type": "json",
        "res_body": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"data\":{\"type\":\"string\"},\"msg\":{\"type\":\"string\"}},\"title\":\"R«string»\",\"$$ref\":\"#/definitions/R«string»\",\"required\":[\"code\"]}",
        "req_body_other": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"分类id\"},\"name\":{\"type\":\"string\",\"description\":\"分类名称\"},\"sort\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"排序\"},\"type\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"分类类型\"}},\"title\":\"CategoryDTO\",\"$$ref\":\"#/definitions/CategoryDTO\",\"required\":[\"id\",\"name\",\"sort\",\"type\"]}",
        "project_id": 10518,
        "catid": 105908,
        "uid": 12769,
        "add_time": 1656056920,
        "up_time": 1656058165,
        "__v": 0,
        "desc": "",
        "markdown": ""
      },
      {
        "query_path": {
          "path": "/admin/category/page",
          "params": []
        },
        "edit_uid": 0,
        "status": "undone",
        "type": "static",
        "req_body_is_json_schema": true,
        "res_body_is_json_schema": true,
        "api_opened": false,
        "index": 0,
        "tag": [
          "分类相关接口"
        ],
        "_id": 323252,
        "method": "GET",
        "title": "分类分页查询",
        "path": "/admin/category/page",
        "req_params": [],
        "req_body_form": [],
        "req_headers": [],
        "req_query": [
          {
            "required": "0",
            "_id": "62b5734b3e12637221f1ff20",
            "name": "name",
            "example": "传统主食",
            "desc": "分类名称"
          },
          {
            "required": "1",
            "_id": "62b5734b3e1263549af1ff1f",
            "name": "page",
            "example": "1",
            "desc": "页码"
          },
          {
            "required": "1",
            "_id": "62b5734b3e1263289cf1ff1e",
            "name": "pageSize",
            "example": "10",
            "desc": "每页记录数"
          },
          {
            "required": "0",
            "_id": "62b5734b3e12630237f1ff1d",
            "name": "type",
            "example": "1",
            "desc": "分类类型：1为菜品分类，2为套餐分类"
          }
        ],
        "req_body_type": "raw",
        "res_body_type": "json",
        "res_body": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"number\"},\"msg\":{\"type\":\"null\"},\"data\":{\"type\":\"object\",\"properties\":{\"total\":{\"type\":\"number\"},\"records\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"type\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"},\"sort\":{\"type\":\"number\"},\"status\":{\"type\":\"number\"},\"createTime\":{\"type\":\"string\"},\"updateTime\":{\"type\":\"string\"},\"createUser\":{\"type\":\"number\"},\"updateUser\":{\"type\":\"number\"}},\"required\":[\"id\",\"type\",\"name\",\"sort\",\"status\",\"createTime\",\"updateTime\",\"createUser\",\"updateUser\"]}}},\"required\":[\"total\",\"records\"]}},\"required\":[\"code\",\"data\"]}",
        "project_id": 10518,
        "catid": 105908,
        "uid": 12769,
        "add_time": 1656056921,
        "up_time": 1656058699,
        "__v": 0,
        "desc": "",
        "markdown": ""
      },
      {
        "query_path": {
          "path": "/admin/category/status/{status}",
          "params": []
        },
        "edit_uid": 0,
        "status": "undone",
        "type": "var",
        "req_body_is_json_schema": true,
        "res_body_is_json_schema": true,
        "api_opened": false,
        "index": 0,
        "tag": [
          "分类相关接口"
        ],
        "_id": 323254,
        "method": "POST",
        "title": "启用、禁用分类",
        "path": "/admin/category/status/{status}",
        "req_params": [
          {
            "_id": "62b577403e126381baf1ff68",
            "name": "status",
            "example": "1",
            "desc": "1为启用，0为禁用"
          }
        ],
        "req_body_form": [],
        "req_headers": [
          {
            "required": "1",
            "_id": "62b577403e126329e1f1ff6a",
            "name": "Content-Type",
            "value": "application/json"
          }
        ],
        "req_query": [
          {
            "required": "1",
            "_id": "62b577403e1263dec6f1ff69",
            "name": "id",
            "example": "100",
            "desc": "分类id"
          }
        ],
        "req_body_type": "json",
        "res_body_type": "json",
        "res_body": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"data\":{\"type\":\"string\"},\"msg\":{\"type\":\"string\"}},\"title\":\"R«string»\",\"$$ref\":\"#/definitions/R«string»\",\"required\":[\"code\"]}",
        "project_id": 10518,
        "catid": 105908,
        "uid": 12769,
        "add_time": 1656056921,
        "up_time": 1656059712,
        "__v": 0,
        "desc": "",
        "markdown": "",
        "req_body_other": ""
      },
      {
        "query_path": {
          "path": "/admin/category",
          "params": []
        },
        "edit_uid": 0,
        "status": "undone",
        "type": "static",
        "req_body_is_json_schema": true,
        "res_body_is_json_schema": true,
        "api_opened": false,
        "index": 0,
        "tag": [
          "分类相关接口"
        ],
        "_id": 323244,
        "method": "POST",
        "title": "新增分类",
        "path": "/admin/category",
        "req_params": [],
        "req_body_form": [],
        "req_headers": [
          {
            "required": "1",
            "_id": "62b570fb3e1263f42df1fefe",
            "name": "Content-Type",
            "value": "application/json"
          }
        ],
        "req_query": [],
        "req_body_type": "json",
        "res_body_type": "json",
        "res_body": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"data\":{\"type\":\"string\"},\"msg\":{\"type\":\"string\"}},\"title\":\"R«string»\",\"$$ref\":\"#/definitions/R«string»\",\"required\":[\"code\"]}",
        "req_body_other": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\",\"description\":\"分类名称\"},\"sort\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"排序，按照升序排序\"},\"type\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"分类类型：1为菜品分类，2为套餐分类\"}},\"title\":\"CategoryDTO\",\"$$ref\":\"#/definitions/CategoryDTO\",\"required\":[\"name\",\"sort\",\"type\"]}",
        "project_id": 10518,
        "catid": 105908,
        "uid": 12769,
        "add_time": 1656056920,
        "up_time": 1656058107,
        "__v": 0,
        "desc": "",
        "markdown": ""
      },
      {
        "query_path": {
          "path": "/admin/category",
          "params": []
        },
        "edit_uid": 0,
        "status": "undone",
        "type": "static",
        "req_body_is_json_schema": true,
        "res_body_is_json_schema": true,
        "api_opened": false,
        "index": 0,
        "tag": [
          "分类相关接口"
        ],
        "_id": 323248,
        "method": "DELETE",
        "title": "根据id删除分类",
        "path": "/admin/category",
        "req_params": [],
        "req_body_form": [],
        "req_headers": [],
        "req_query": [
          {
            "required": "1",
            "_id": "62b571bb3e1263ab86f1ff06",
            "name": "id",
            "example": "100",
            "desc": "分类id"
          }
        ],
        "req_body_type": "raw",
        "res_body_type": "json",
        "res_body": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"data\":{\"type\":\"string\"},\"msg\":{\"type\":\"string\"}},\"title\":\"R«string»\",\"$$ref\":\"#/definitions/R«string»\",\"required\":[\"code\"]}",
        "project_id": 10518,
        "catid": 105908,
        "uid": 12769,
        "add_time": 1656056920,
        "up_time": 1656058299,
        "__v": 0,
        "desc": "",
        "markdown": "",
        "req_body_other": ""
      },
      {
        "query_path": {
          "path": "/admin/category/list",
          "params": []
        },
        "edit_uid": 0,
        "status": "undone",
        "type": "static",
        "req_body_is_json_schema": true,
        "res_body_is_json_schema": true,
        "api_opened": false,
        "index": 0,
        "tag": [
          "分类相关接口"
        ],
        "_id": 323250,
        "method": "GET",
        "title": "根据类型查询分类",
        "path": "/admin/category/list",
        "req_params": [],
        "req_body_form": [],
        "req_headers": [],
        "req_query": [
          {
            "required": "0",
            "_id": "62b572323e12631e94f1ff0a",
            "name": "type",
            "example": "2",
            "desc": "分类类型：1为菜品分类，2为套餐分类"
          }
        ],
        "req_body_type": "raw",
        "res_body_type": "json",
        "res_body": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"data\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"createTime\":{\"type\":\"string\",\"format\":\"date-time\"},\"createUser\":{\"type\":\"integer\",\"format\":\"int64\"},\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"},\"sort\":{\"type\":\"integer\",\"format\":\"int32\"},\"status\":{\"type\":\"integer\",\"format\":\"int32\"},\"type\":{\"type\":\"integer\",\"format\":\"int32\"},\"updateTime\":{\"type\":\"string\",\"format\":\"date-time\"},\"updateUser\":{\"type\":\"integer\",\"format\":\"int64\"}},\"title\":\"Category\",\"$$ref\":\"#/definitions/Category\"}},\"msg\":{\"type\":\"string\"}},\"title\":\"R«List«Category»»\",\"$$ref\":\"#/definitions/R«List«Category»»\",\"required\":[\"code\"]}",
        "project_id": 10518,
        "catid": 105908,
        "uid": 12769,
        "add_time": 1656056921,
        "up_time": 1656058418,
        "__v": 0,
        "desc": "",
        "markdown": ""
      }
    ]
  },
  {
    "index": 0,
    "name": "员工相关接口",
    "desc": "Employee Controller",
    "add_time": 1656056920,
    "up_time": 1656056920,
    "list": [
      {
        "query_path": {
          "path": "/admin/employee/editPassword",
          "params": []
        },
        "edit_uid": 0,
        "status": "undone",
        "type": "static",
        "req_body_is_json_schema": true,
        "res_body_is_json_schema": true,
        "api_opened": false,
        "index": 0,
        "tag": [
          "员工相关接口"
        ],
        "_id": 323276,
        "method": "PUT",
        "title": "修改密码",
        "path": "/admin/employee/editPassword",
        "req_params": [],
        "req_body_form": [],
        "req_headers": [
          {
            "required": "1",
            "_id": "62b575263e1263d67ef1ff41",
            "name": "Content-Type",
            "value": "application/json"
          }
        ],
        "req_query": [],
        "req_body_type": "json",
        "res_body_type": "json",
        "res_body": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"data\":{\"type\":\"string\"},\"msg\":{\"type\":\"string\"}},\"title\":\"R«string»\",\"$$ref\":\"#/definitions/R«string»\",\"required\":[\"code\"]}",
        "req_body_other": "{\"type\":\"object\",\"properties\":{\"empId\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"员工id\"},\"newPassword\":{\"type\":\"string\",\"description\":\"新密码\"},\"oldPassword\":{\"type\":\"string\",\"description\":\"旧密码\"}},\"title\":\"PasswordEditDTO\",\"$$ref\":\"#/definitions/PasswordEditDTO\",\"required\":[\"empId\",\"newPassword\",\"oldPassword\"]}",
        "project_id": 10518,
        "catid": 105911,
        "uid": 12769,
        "add_time": 1656056922,
        "up_time": 1656059174,
        "__v": 0,
        "desc": "",
        "markdown": ""
      },
      {
        "query_path": {
          "path": "/admin/employee/status/{status}",
          "params": []
        },
        "edit_uid": 0,
        "status": "undone",
        "type": "var",
        "req_body_is_json_schema": true,
        "res_body_is_json_schema": true,
        "api_opened": false,
        "index": 0,
        "tag": [
          "员工相关接口"
        ],
        "_id": 323284,
        "method": "POST",
        "title": "启用、禁用员工账号",
        "path": "/admin/employee/status/{status}",
        "req_params": [
          {
            "_id": "62b5772b3e12638732f1ff63",
            "name": "status",
            "example": "1",
            "desc": "状态，1为启用 0为禁用"
          }
        ],
        "req_body_form": [],
        "req_headers": [
          {
            "required": "1",
            "_id": "62b5772b3e126300d3f1ff65",
            "name": "Content-Type",
            "value": "application/json"
          }
        ],
        "req_query": [
          {
            "required": "1",
            "_id": "62b5772b3e1263e3faf1ff64",
            "name": "id",
            "desc": "员工id"
          }
        ],
        "req_body_type": "json",
        "res_body_type": "json",
        "res_body": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"data\":{\"type\":\"string\"},\"msg\":{\"type\":\"string\"}},\"title\":\"R«string»\",\"$$ref\":\"#/definitions/R«string»\",\"required\":[\"code\"]}",
        "project_id": 10518,
        "catid": 105911,
        "uid": 12769,
        "add_time": 1656056922,
        "up_time": 1656059691,
        "__v": 0,
        "desc": "",
        "markdown": "",
        "req_body_other": ""
      }
    ]
  }
]
本作品采用《CC 协议》，转载必须注明作者和本文链接
写这些文章的初衷只是记录一下自己的学习过程，避免自己忘记
全网第一菜鸡
280 声望
写这些文章的初衷只是记录一下自己的学习过程，避免自己忘记
讨论数量: 1
排序：
时间 投票
自由与温暖是遥不可及的梦想
课程读者 231 声望 / 技术经理 @ 上海尤里卡信息科技有限公司

说实话 不好用

3个月前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！
支持 MD 帮助
全网第一菜鸡
未填写
文章
104
粉丝
6
喜欢
39
收藏
75
排名：841
访问：7919
私信
所有博文
文章归档
3 篇 2024 年 4 月 1 篇 2024 年 3 月 3 篇 2024 年 2 月 9 篇 2024 年 1 月 3 篇 2023 年 12 月 2 篇 2023 年 10 月 8 篇 2023 年 9 月 11 篇 2023 年 8 月 8 篇 2023 年 7 月 6 篇 2023 年 6 月 3 篇 2023 年 5 月 3 篇 2023 年 4 月 1 篇 2023 年 2 月 2 篇 2022 年 9 月 4 篇 2022 年 7 月 2 篇 2022 年 6 月 2 篇 2022 年 1 月 4 篇 2021 年 10 月 1 篇 2021 年 8 月 3 篇 2021 年 7 月 2 篇 2021 年 6 月 4 篇 2021 年 5 月 3 篇 2020 年 11 月 13 篇 2020 年 8 月 3 篇 2020 年 7 月
最新文章 最受欢迎
2周前 thinkphp如何隐藏index.php 3周前 多线程相关问题 3周前 java集合相关问题 1个月前 mysql报错Host is not allowed to connect to this MariaDB server 2个月前 Centos下安装jenkins
15 PHP 结合 MySQL 千万级数据处理 3 编写一个类，实现类似JWT功能 2 微信支付 2 PHP获取当前季度的开始时间和结束时间 2 Redis集群
博客标签
redis
6
 gateway
1
 php
2
 docker
14
 mysql
1
 gitlab
1
 es
2
 aes
1
 MQ
2
 thinkphp
1
 VMware
1
 feign
1
 多线程
1
 jmeter
1
 分布式
1
 微服务
3
 集合
1
 go
2
 python
1
 java
10
 linux
2
 centos8服务器安全高级篇
3
 nacos
2
 nginx
1
 springboot
3
 springcloud
1
 Jenkins
1
 seata
2
 zookeeper
1
 spring-cloud
7
 登录校验
1
社区赞助商
成为赞助商

关于 LearnKu

LearnKu 是终身编程者的修道场
做最专业、严肃的技术论坛
LearnKu 诞生的故事

资源推荐

  • 《社区使用指南》
  • 《文档撰写指南》
  • 《LearnKu 社区规范》
  • 《提问的智慧》

    • 服务提供商

    其他信息

  • 成为版主
  • 所有测验
  • 联系站长（反馈建议）

    • 粤ICP备18099781号-6 | 粤公网安备 44030502004330号 | 违法和不良信息举报

    由 Summer 设计和编码 ❤

    请登录

    内容举报
    匿名举报，为防止滥用，仅管理员可见举报者。

    我要举报该，理由是：

    取消