1
1
using System ;
2
2
using System . Web . Http ;
3
+ using NSwag . Annotations ;
3
4
using SiteServer . CMS . Api . V1 ;
4
5
using SiteServer . CMS . Core ;
5
6
using SiteServer . CMS . DataCache ;
8
9
9
10
namespace SiteServer . API . Controllers . V1
10
11
{
11
- /// <summary>
12
- /// Administrators
13
- /// </summary>
14
12
[ RoutePrefix ( "v1/administrators" ) ]
15
13
public class AdministratorsController : ApiController
16
14
{
@@ -20,6 +18,7 @@ public class AdministratorsController : ApiController
20
18
private const string RouteActionsResetPassword = "actions/resetPassword" ;
21
19
private const string RouteAdministrator = "{id:int}" ;
22
20
21
+ [ OpenApiOperation ( "新增管理员 API" , "https://sscms.com/docs/v6/api/guide/administrators/create.html" ) ]
23
22
[ HttpPost , Route ( Route ) ]
24
23
public IHttpActionResult Create ( [ FromBody ] AdministratorInfoCreateUpdate adminInfo )
25
24
{
@@ -47,6 +46,7 @@ public IHttpActionResult Create([FromBody] AdministratorInfoCreateUpdate adminIn
47
46
}
48
47
}
49
48
49
+ [ OpenApiOperation ( "修改管理员 API" , "https://sscms.com/docs/v6/api/guide/administrators/update.html" ) ]
50
50
[ HttpPut , Route ( RouteAdministrator ) ]
51
51
public IHttpActionResult Update ( int id , [ FromBody ] AdministratorInfoCreateUpdate adminInfo )
52
52
{
@@ -78,6 +78,7 @@ public IHttpActionResult Update(int id, [FromBody] AdministratorInfoCreateUpdate
78
78
}
79
79
}
80
80
81
+ [ OpenApiOperation ( "删除管理员 API" , "https://sscms.com/docs/v6/api/guide/administrators/delete.html" ) ]
81
82
[ HttpDelete , Route ( RouteAdministrator ) ]
82
83
public IHttpActionResult Delete ( int id )
83
84
{
@@ -103,6 +104,7 @@ public IHttpActionResult Delete(int id)
103
104
}
104
105
}
105
106
107
+ [ OpenApiOperation ( "获取管理员 API" , "https://sscms.com/docs/v6/api/guide/administrators/get.html" ) ]
106
108
[ HttpGet , Route ( RouteAdministrator ) ]
107
109
public IHttpActionResult Get ( int id )
108
110
{
@@ -128,6 +130,7 @@ public IHttpActionResult Get(int id)
128
130
}
129
131
}
130
132
133
+ [ OpenApiOperation ( "获取管理员列表 API" , "https://sscms.com/docs/v6/api/guide/administrators/list.html" ) ]
131
134
[ HttpGet , Route ( Route ) ]
132
135
public IHttpActionResult List ( )
133
136
{
@@ -152,6 +155,7 @@ public IHttpActionResult List()
152
155
}
153
156
}
154
157
158
+ [ OpenApiOperation ( "管理员登录 API" , "https://sscms.com/docs/v6/api/guide/administrators/login.html" ) ]
155
159
[ HttpPost , Route ( RouteActionsLogin ) ]
156
160
public IHttpActionResult Login ( )
157
161
{
@@ -212,6 +216,7 @@ public IHttpActionResult Login()
212
216
}
213
217
}
214
218
219
+ [ OpenApiOperation ( "管理员退出登录 API" , "https://sscms.com/docs/v6/api/guide/administrators/logout.html" ) ]
215
220
[ HttpPost , Route ( RouteActionsLogout ) ]
216
221
public IHttpActionResult Logout ( )
217
222
{
@@ -233,6 +238,7 @@ public IHttpActionResult Logout()
233
238
}
234
239
}
235
240
241
+ [ OpenApiOperation ( "修改管理员密码 API" , "https://sscms.com/docs/v6/api/guide/administrators/resetPassword.html" ) ]
236
242
[ HttpPost , Route ( RouteActionsResetPassword ) ]
237
243
public IHttpActionResult ResetPassword ( )
238
244
{
0 commit comments