为了测试,我暂时在文件里粘贴了一个markdown格式的api:
**简要描述:**- 用户登录接口
**请求URL:**
- ` `
**请求方式:**
- POST
**参数:**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|username |是 |string |用户名 |
|password |是 |string | 密码 |
**返回示例**
```
{
"error_code": 0,
"data": {
"uid": "1",
"username": "zhai coder",
"name": "翟码农",
"groupid": 2 ,
"reg_time": "2019-08-01",
"last_login_time": "0",
}
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|----- |
|groupid |int |用户组id,1:超级管理员;2:普通用户 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
最后还需要准备好一个view文件。
我是创建在resources/views文件夹下的,文件名为:apidoc_admin.blade.php。
方便表达我强烈的推荐意愿,css样式我都给大家调好了,大家直接拿去用吧。
<!doctype html><html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
<head>
<meta charset="utf-8">
<meta content="width=device-width, initial-scale=1">
<title>Laravel</title>
<style>
html, body {
background-color: #fff;
color: #636b6f;
font-family: 'Nunito', sans-serif;
font-weight: 200;
height: 100vh;
margin: 0;
color:#222; }
.container{
width:800px;
margin:10px auto;
padding:20px;
border-left:2px solid silver;
border-right:2px solid silver; }
table th,td{
border:1px solid #ede;
padding:5px 10px; }
pre{
background: #666;
color: white;
padding: 20px 10px;
font-family: yahei;
overflow: auto; }
li code{
font-size: 28px;
color: #4eb4ee;
font-weight: bold;
}
</style>
</head>
<body>
<div>
{!! $content !!}
</div>
</body>
</html>
到这里,所有工作算是完成了。
在浏览器输入api文档访问地址:
一幅如画卷般的文档页面就出来喽。最终效果图如顶图所示。