tk/IGeekFan.AspNetCore.Knife4jUI
1
0
Fork 0
mirror of https://github.com/nsnail/IGeekFan.AspNetCore.Knife4jUI.git synced 2025-08-02 11:50:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

update package

Browse Source
This commit is contained in:
luoyunchong
2021-09-02 23:28:12 +08:00
parent 66cd518872
commit 1e9fb7d195
52 changed files with 434 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
test/Basic/Controllers/FilesController.cs
View File

@ -26,6 +26,13 @@ namespace Basic.Controllers
throw new NotImplementedException();
}
[HttpPost("form-with-user")]
public IActionResult PostFormUser([FromForm] FormUser FormUser)
{
throw new NotImplementedException();
}
[HttpGet("{name}")]
[Produces("application/octet-stream", Type = typeof(FileResult))]
public FileResult GetFile(string name)
@ -47,4 +54,11 @@ namespace Basic.Controllers
public IFormFile File { get; set; }
}
public class FormUser
{
public string Name { get; set; }
public string User { get; set; }
}
}

10
test/Basic/Startup.cs
View File

@ -104,21 +104,21 @@ namespace Basic
app.UseSwaggerUI(c =>
{
c.RoutePrefix = "swagger"; // serve the UI at root
c.SwaggerEndpoint("/v1/api-docs", "V1 Docs");
c.SwaggerEndpoint("/gp/api-docs", "<22><>¼ģ<C2BC><C4A3>");
c.SwaggerEndpoint("/v1/swagger.json", "V1 Docs");
c.SwaggerEndpoint("/gp/swagger.json", "<22><>¼ģ<C2BC><C4A3>");
});
app.UseKnife4UI(c =>
{
c.RoutePrefix = ""; // serve the UI at root
c.SwaggerEndpoint("/v1/api-docs", "V1 Docs");
c.SwaggerEndpoint("/gp/api-docs", "<22><>¼ģ<C2BC><C4A3>");
c.SwaggerEndpoint("/v1/swagger.json", "V1 Docs");
c.SwaggerEndpoint("/gp/swagger.json", "<22><>¼ģ<C2BC><C4A3>");
});
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
endpoints.MapSwagger("{documentName}/api-docs");
endpoints.MapSwagger("{documentName}/swagger.json");
});
}

56
test/Knife4jUIDemo/Controllers/WeatherForecastController.cs
View File

@ -1,9 +1,8 @@
using System;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
namespace Knife4jUIDemo.Controllers
{
@ -11,7 +10,7 @@ namespace Knife4jUIDemo.Controllers
/// 中文这是一个Get请求这是一个Get请求
/// </summary>
[ApiController]
[Route("api/WeatherForecast")]
[Route("api/WeatherForecast/[action]")]
public class WeatherForecastController : ControllerBase
{
private static readonly string[] Summaries = new[]
@ -26,6 +25,38 @@ namespace Knife4jUIDemo.Controllers
_logger = logger;
}
/// <summary>
/// 得到一个ErrorCode
/// </summary>
/// <returns></returns>
[HttpGet]
public ErrorCode GetErrorCode()
{
return ErrorCode.Success;
}
[HttpGet]
public ErrorCode GetErrorCode2(ErrorCode errorCode)
{
return errorCode;
}
[HttpGet]
public IActionResult GetErrorCode4(ErrorCode errorCode)
{
return new JsonResult(new PostErrorCodeDto() { Message="a",ErrorCode=errorCode});
}
/// <summary>
/// 发送一个Post
/// </summary>
/// <returns></returns>
[HttpPost]
public PostErrorCodeDto PostErrorCode([FromBody] PostErrorCodeDto PostErrorCodeDto)
{
return PostErrorCodeDto;
}
/// <summary>
/// 这是一个Get请求
/// </summary>
@ -43,4 +74,19 @@ namespace Knife4jUIDemo.Controllers
.ToArray();
}
}
/// <summary>
/// 请求实体
/// </summary>
public class PostErrorCodeDto
{
/// <summary>
/// 异常信息
/// </summary>
public string Message { get; set; }
/// <summary>
/// 状态码
/// </summary>
public ErrorCode ErrorCode { get; set; }
}
}

81
test/Knife4jUIDemo/ErrorCode.cs Normal file
View File

@ -0,0 +1,81 @@
using System.ComponentModel;
namespace Knife4jUIDemo
{
/// <summary>
/// 注释ErrorCode
/// </summary>
public enum ErrorCode
{
/// <summary>
/// 操作成功
/// </summary>
Success = 0,
/// <summary>
/// 未知错误
/// </summary>
UnknownError = 1007,
/// <summary>
/// 服务器未知错误
/// </summary>
ServerUnknownError = 999,
/// <summary>
/// 失败
/// </summary>
Error = 1000,
/// <summary>
/// 认证失败
/// </summary>
AuthenticationFailed = 10000,
/// <summary>
/// 无权限
/// </summary>
NoPermission = 10001,
/// <summary>
/// 失败
/// </summary>
Fail = 9999,
/// <summary>
/// refreshToken异常
/// </summary>
RefreshTokenError = 10100,
/// <summary>
/// 资源不存在
/// </summary>
NotFound = 10020,
/// <summary>
/// 参数错误
/// </summary>
[Description("参数错误")]
ParameterError = 10030,
/// <summary>
/// 令牌失效
/// </summary>
[Description("令牌失效")]
TokenInvalidation = 10040,
/// <summary>
/// 令牌过期
/// </summary>
TokenExpired = 10050,
/// <summary>
/// 字段重复
/// </summary>
RepeatField = 10060,
/// <summary>
/// 禁止操作
/// </summary>
Inoperable = 10070,
//10080 请求方法不允许
//10110 文件体积过大
//10120 文件数量过多
//10130 文件扩展名不符合规范
//10140 请求过于频繁，请稍后重试
ManyRequests = 10140
}
}

102
test/Knife4jUIDemo/Knife4jUIDemo.xml
View File

@ -9,11 +9,113 @@
中文这是一个Get请求这是一个Get请求
</summary>
</member>
<member name="M:Knife4jUIDemo.Controllers.WeatherForecastController.GetErrorCode">
<summary>
得到一个ErrorCode
</summary>
<returns></returns>
</member>
<member name="M:Knife4jUIDemo.Controllers.WeatherForecastController.PostErrorCode(Knife4jUIDemo.Controllers.PostErrorCodeDto)">
<summary>
发送一个Post
</summary>
<returns></returns>
</member>
<member name="M:Knife4jUIDemo.Controllers.WeatherForecastController.Get">
<summary>
这是一个Get请求
</summary>
<returns></returns>
</member>
<member name="T:Knife4jUIDemo.Controllers.PostErrorCodeDto">
<summary>
请求实体
</summary>
</member>
<member name="P:Knife4jUIDemo.Controllers.PostErrorCodeDto.Message">
<summary>
异常信息
</summary>
</member>
<member name="P:Knife4jUIDemo.Controllers.PostErrorCodeDto.ErrorCode">
<summary>
状态码
</summary>
</member>
<member name="T:Knife4jUIDemo.ErrorCode">
<summary>
注释ErrorCode
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.Success">
<summary>
操作成功
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.UnknownError">
<summary>
未知错误
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.ServerUnknownError">
<summary>
服务器未知错误
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.Error">
<summary>
失败
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.AuthenticationFailed">
<summary>
认证失败
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.NoPermission">
<summary>
无权限
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.Fail">
<summary>
失败
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.RefreshTokenError">
<summary>
refreshToken异常
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.NotFound">
<summary>
资源不存在
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.ParameterError">
<summary>
参数错误
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.TokenInvalidation">
<summary>
令牌失效
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.TokenExpired">
<summary>
令牌过期
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.RepeatField">
<summary>
字段重复
</summary>
</member>
<member name="F:Knife4jUIDemo.ErrorCode.Inoperable">
<summary>
禁止操作
</summary>
</member>
</members>
</doc>

8
test/Knife4jUIDemo/Startup.cs
View File

@ -60,20 +60,20 @@ namespace Knife4jUIDemo
app.UseSwaggerUI(c =>
{
c.RoutePrefix = "swagger"; // serve the UI at root
c.SwaggerEndpoint("/v1/api-docs", "LinCms");
c.SwaggerEndpoint("v1/swagger.json", "My API V1");
//c.SwaggerEndpoint("/v1/api-docs", "LinCms");
});
app.UseKnife4UI(c =>
{
c.RoutePrefix = ""; // serve the UI at root
c.SwaggerEndpoint("/v1/api-docs", "V1 Docs");
c.SwaggerEndpoint("/v1/swagger.json", "V1 Docs");
});
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
endpoints.MapSwagger("{documentName}/api-docs");
endpoints.MapSwagger("{documentName}/swagger.json");
});
}
}