简介

vue-component 组件，字段说明

名称	类型	必填	描述
url	string	是	请求的路径
title	string	否	顶部文案
tagDesc	string	否	在所有tag上面 -> 进行描述
tag	string	否	请求的method(默认get) -> post/get/put/xxx
tags	array	否	重要提示内容
params	map/distionary	否	请求参数-字段说明
response	map/distionary	否	响应参数-字段说明

API:样例

采用 vue-component 组件 , 所有参数都是非必填的

注意 :+参数

<api
  url="login/regist -> 路径"
  title="顶部文案"

  tagDesc="在所有tag上面 -> 进行描述"
  tag="请求的method(默认get) -> post/get/put/xxx"
  :tags="['重要提示内容']"

  // 请求参数-字段说明
  :params="[
    {
      name: '字段名xx',
      type: '字段类型 -> string/int/array/object/xxx',
      must: '是/否 -> 描述是否为必填项，非必填 可以不写',
      desc: '该字段的描述内容'
      value: '请求的值 -> 基本数据类型、对象、数组'
    },
    {
      name: '字段名xx',
      type: '字段类型 -> string/int/array/object/xxx',
      must: '是/否 -> 描述是否为必填项，非必填 可以不写',
      desc: '该字段的描述内容'
      value: {
        a: 1,
        b: 'hello'
      }
    },
    ...
  ]"

  // 响应参数-字段说明 -> (内容格式 = 请求参数-字段说明)
  :response="[
    {
      name: '字段名xx',
      type: '字段类型 -> string/int/array/object/xxx',
      must: '是/否 -> 描述是否为必填项，非必填 可以不写',
      desc: '该字段的描述内容'
    },
    ...
  ]"
/>