/bygo

useful utils in my work

Primary LanguageGoApache License 2.0Apache-2.0

bygo

{% api-method method="get" host="https://123.com" path="/v1/user" %} {% api-method-summary %} 获取用户信息 {% endapi-method-summary %}

{% api-method-description %} 获取用户信息 {% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-query-parameters %} {% api-method-parameter name="id" type="number" required=false %} 用户id {% endapi-method-parameter %} {% endapi-method-query-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
    "id": 1,
    "name": "bysir"
}

{% endapi-method-response-example %}

{% api-method-response-example httpCode=500 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
    "code": 2000,
    "msg": "服务器错误"
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}