Appearance
本文主要介绍如何快速的使用Knife4jInsight平台,用户可以通过在线版本进行注册试用
1.创建Namespace
假设以一个项目维度为例,建立一个电商平台的项目接口文档,此时新建该项目的namespace,如下图:
创建完成后,需要填写OpenAPI规范数据源,此时创建ApiRegsiter
2.创建ApiRegister(OpenAPI数据源实例)
点击菜单ApiRegister,点击新增创建,如下图:
OpenAPI数据源有两种模式:
- HTTP接口:即提供OpenAPI数据源的方式,可以通过HTTP接口进行提供,平台会自动调用获取
可以使用Knife4j的在线Demo数据,地址:https://doc.xiaominfo.com/demo/data/knife4j.json
- Editor编辑器:在线编辑设计,按OpenAPI规范进行接口的设计,OpenAPI规范可以参考文档
2.1 HTTP接口模式
接口模式,填写地址即可
如下图:
2.2 编辑器模式
Editor编辑器模式则是将OpenAPI数据源贴进来,可以进行编辑修改,支持JSON
、YAML
两种模式
如下图:
3.文档预览
在ApiRegister列表中,点击数据中的链接地址,即可在线查看文档