呈现前端接口文档
约 259 字小于 1 分钟
2025-02-12
浏览接口
打开一个网页浏览器,在地址栏中输入以下 URL:http://webapi 地址/Miragedoc,这样就可以显示所有微服务的前端 API 文档。
注意
Asp.net改造的工程,不在此处展示文档。
Asp.net改造的工程,不在此处展示文档。
从文档描述来看,通过 post json 的方式,把参数组合成数组,提交到 WebApi 即可。 简单写个 js 代码测试一下:
<script>
async function test(name,age) {
var ret = await fetch("http://127.0.0.1:5002/DemoService/HelloWorld",
{
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify([name, age])
});
if (ret.status == 200) {
alert(await ret.text());
}
else
alert("error");
}
test("Jack", 666);
</script>
接口分类
如果一个 Controller 里面有较多的方法,那么,可以使用 CategoryAttribute 对方法进行分类显示。
/// <summary>
/// 获取系统详情
/// </summary>
/// <returns></returns>
[Category("详情")]
public Task<Info[]> GetInfos()
{
...
}
/// <summary>
/// 获取账户详情
/// </summary>
/// <returns></returns>
[Category("详情")]
public Task<Account> GetAccountInfo()
{
...
}
呈现的效果如下: