+
Skip to content

Fix generate Swagger Docs #543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ public async Task<ActionResult> Export()
}

[Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "SuperAdmin, Admin")]
[HttpPost, HttpOptions]
[HttpPost]
[Route("import-data/{mixDatabaseName}")]
public async Task<ActionResult<RepositoryResponse<ImportViewModel>>> ImportData(string mixDatabaseName, [FromForm] IFormFile file)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public override async Task<ActionResult<PaginationModel<ReadMvcViewModel>>> Get(
}
}

[HttpGet, HttpOptions]
[HttpGet]
[Route("init-form/{moduleId}")]
public async Task<ActionResult<UpdateViewModel>> InitByIdAsync(int moduleId)
{
Expand All @@ -85,7 +85,7 @@ public async Task<ActionResult<UpdateViewModel>> InitByIdAsync(int moduleId)
}
}

[HttpPost, HttpOptions]
[HttpPost]
[Route("save/{moduleName}")]
public async Task<RepositoryResponse<UpdateViewModel>> SaveByName(string moduleName, [FromBody] JObject data)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ public async Task<ActionResult<FileViewModel>> Export()
}

// GET api/module-data/create/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("init-form/{moduleId}")]
public async Task<ActionResult<UpdateViewModel>> InitByIdAsync(int moduleId)
{
Expand All @@ -142,7 +142,7 @@ public async Task<ActionResult<UpdateViewModel>> InitByIdAsync(int moduleId)
}

// GET api/module-data/create/id
[HttpPost, HttpOptions]
[HttpPost]
[Route("save/{moduleName}")]
public async Task<RepositoryResponse<UpdateViewModel>> SaveByName(string moduleName, [FromBody] JObject data)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ protected override Task<RepositoryResponse<T>> GetSingleAsync<T>(string id)
}

// POST api/theme
/// Swagger cannot generate multi-form value api
[ApiExplorerSettings(IgnoreApi = true)]
[Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "SuperAdmin, Admin")]
[HttpPost, HttpOptions]
[DisableRequestSizeLimit]
Expand Down
2 changes: 1 addition & 1 deletion src/Mix.Cms.Api.RestFul/ServiceCollectionExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public static IServiceCollection AddMixRestApi(this IServiceCollection services)
{
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "Mixcore API", Version = "v3" });
c.SwaggerDoc("v1", new OpenApiInfo { Title = "Mixcore API", Version = "v1" });
c.CustomSchemaIds(x => x.FullName);
});
return services;
Expand Down
6 changes: 3 additions & 3 deletions src/Mix.Cms.Api/Controllers/v1/ApiAccountController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public ApiAccountController(
// POST: /Account/Logout

[Route("Logout")]
[HttpGet, HttpPost, HttpOptions]
[HttpGet, HttpPost]
public async Task<RepositoryResponse<bool>> Logout()
{
var result = new RepositoryResponse<bool>() { IsSucceed = true, Data = true };
Expand Down Expand Up @@ -192,7 +192,7 @@ public async Task<ActionResult<RepositoryResponse<AccessTokenViewModel>>> Regist
[Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme)]
[MixAuthorize]
[Route("user-in-role")]
[HttpPost, HttpOptions]
[HttpPost]
public async Task<RepositoryResponse<bool>> ManageUserInRole([FromBody] UserRoleModel model)
{
var role = await _roleManager.FindByIdAsync(model.RoleId);
Expand Down Expand Up @@ -430,7 +430,7 @@ public async Task<RepositoryResponse<PaginationModel<UserInfoViewModel>>> GetLis
return data;
}

[HttpPost, HttpOptions]
[HttpPost]
[Route("forgot-password")]
public async Task<RepositoryResponse<string>> ForgotPassword([FromBody] Mix.Identity.Models.AccountViewModels.ForgotPasswordViewModel model)
{
Expand Down
8 changes: 4 additions & 4 deletions src/Mix.Cms.Api/Controllers/v1/ApiConfigurationController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public ApiConfigurationController(MixCmsContext context, IMemoryCache memoryCach
#region Get

// GET api/configuration/keyword
[HttpGet, HttpOptions]
[HttpGet]
[Route("delete/{keyword}")]
public async Task<RepositoryResponse<MixConfiguration>> DeleteAsync(string keyword)
{
Expand All @@ -47,7 +47,7 @@ public async Task<RepositoryResponse<MixConfiguration>> DeleteAsync(string keywo
}

// GET api/configurations/keyword
[HttpGet, HttpOptions]
[HttpGet]
[Route("details/{keyword}/{viewType}")]
[Route("details/{viewType}")]
public async Task<ActionResult<JObject>> Details(string viewType, string keyword)
Expand Down Expand Up @@ -104,7 +104,7 @@ public async Task<ActionResult<JObject>> Details(string viewType, string keyword

// POST api/configuration
[Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "SuperAdmin, Admin")]
[HttpPost, HttpOptions]
[HttpPost]
[Route("save")]
public async Task<RepositoryResponse<UpdateViewModel>> Save([FromBody] UpdateViewModel model)
{
Expand All @@ -119,7 +119,7 @@ public async Task<RepositoryResponse<UpdateViewModel>> Save([FromBody] UpdateVie
}

// GET api/configuration
[HttpPost, HttpOptions]
[HttpPost]
[Route("list")]
public async Task<ActionResult<JObject>> GetList(
[FromBody] RequestPaging request)
Expand Down
8 changes: 4 additions & 4 deletions src/Mix.Cms.Api/Controllers/v1/ApiCultureController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public ApiCultureController(
#region Get

// GET api/culture/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("delete/{id}")]
public async Task<RepositoryResponse<MixCulture>> DeleteAsync(int id)
{
Expand All @@ -58,7 +58,7 @@ public async Task<RepositoryResponse<MixCulture>> DeleteAsync(int id)
}

// GET api/cultures/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("details/{id}/{viewType}")]
[Route("details/{viewType}")]
public async Task<ActionResult<JObject>> Details(string viewType, int? id)
Expand Down Expand Up @@ -113,7 +113,7 @@ public async Task<ActionResult<JObject>> Details(string viewType, int? id)

// POST api/culture
[Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "SuperAdmin, Admin")]
[HttpPost, HttpOptions]
[HttpPost]
[Route("save")]
public async Task<RepositoryResponse<UpdateViewModel>> Save([FromBody] UpdateViewModel model)
{
Expand All @@ -132,7 +132,7 @@ public async Task<RepositoryResponse<UpdateViewModel>> Save([FromBody] UpdateVie
}

// GET api/culture
[HttpPost, HttpOptions]
[HttpPost]
[Route("list")]
public async Task<ActionResult<JObject>> GetList(
[FromBody] RequestPaging request)
Expand Down
10 changes: 5 additions & 5 deletions src/Mix.Cms.Api/Controllers/v1/ApiFileController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public ApiFileController(MixCmsContext context, IMemoryCache memoryCache, Micros
#region Post

// Post api/files/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("details")]
public RepositoryResponse<FileViewModel> Details(string folder, string filename)
{
Expand All @@ -48,7 +48,7 @@ public RepositoryResponse<FileViewModel> Details(string folder, string filename)
}

// GET api/files/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("delete")]
public RepositoryResponse<bool> Delete()
{
Expand All @@ -69,7 +69,7 @@ public RepositoryResponse<bool> Delete()
/// <param name="file"></param> Ex: { "base64": "", "fileFolder":"" }
/// <returns></returns>
[Route("upload-file")]
[HttpPost, HttpOptions]
[HttpPost]
public IActionResult Upload([FromForm] string folder, [FromForm] IFormFile file)
{
if (ModelState.IsValid)
Expand All @@ -81,7 +81,7 @@ public IActionResult Upload([FromForm] string folder, [FromForm] IFormFile file)
}

// POST api/files
[HttpPost, HttpOptions]
[HttpPost]
[Route("save")]
public RepositoryResponse<FileViewModel> Save([FromBody] FileViewModel model)
{
Expand All @@ -98,7 +98,7 @@ public RepositoryResponse<FileViewModel> Save([FromBody] FileViewModel model)
}

// GET api/files
[HttpPost, HttpOptions]
[HttpPost]
[Route("list")]
public RepositoryResponse<FilePageViewModel> GetList([FromBody] RequestPaging request)
{
Expand Down
15 changes: 9 additions & 6 deletions src/Mix.Cms.Api/Controllers/v1/ApiInitCmsController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public ApiInitCmsController(
/// </summary>
/// <param name="model"></param>
/// <returns></returns>
[HttpPost, HttpOptions]
[HttpPost]
[Route("init-cms/step-1")]
public async Task<RepositoryResponse<bool>> Step1([FromBody] InitCmsViewModel model)
{
Expand All @@ -87,7 +87,7 @@ public async Task<RepositoryResponse<bool>> Step1([FromBody] InitCmsViewModel mo
/// </summary>
/// <param name="model"></param>
/// <returns></returns>
[HttpPost, HttpOptions]
[HttpPost]
[Route("init-cms/step-2")]
public async Task<RepositoryResponse<AccessTokenViewModel>> InitSuperAdmin([FromBody] MixRegisterViewModel model)
{
Expand Down Expand Up @@ -151,7 +151,7 @@ public async Task<RepositoryResponse<AccessTokenViewModel>> InitSuperAdmin([From
// /// </summary>
// /// <param name="model"></param>
// /// <returns></returns>
// [HttpPost, HttpOptions]
// [HttpPost]
// [Route("init-cms/step-5")]
// public async Task<RepositoryResponse<bool>> InitConfigurations([FromBody]List<MixConfiguration> model)
// {
Expand Down Expand Up @@ -182,7 +182,7 @@ public async Task<RepositoryResponse<AccessTokenViewModel>> InitSuperAdmin([From
/// </summary>
/// <param name="model"></param>
/// <returns></returns>
[HttpPost, HttpOptions]
[HttpPost]
[Route("init-cms/step-4")]
public async Task<RepositoryResponse<bool>> InitLanguages([FromBody] List<MixLanguage> model)
{
Expand Down Expand Up @@ -215,7 +215,10 @@ public async Task<RepositoryResponse<bool>> InitLanguages([FromBody] List<MixLan
/// </summary>
/// <param name="model"></param>
/// <returns></returns>
[HttpPost, HttpOptions]
///
/// Swagger cannot generate multi-form value api
[ApiExplorerSettings(IgnoreApi = true)]
[HttpPost]
[Route("init-cms/step-3")]
[DisableRequestSizeLimit]
public async Task<RepositoryResponse<Cms.Lib.ViewModels.MixThemes.InitViewModel>> Save([FromForm] string model, [FromForm] IFormFile assets, [FromForm] IFormFile theme)
Expand All @@ -230,7 +233,7 @@ public async Task<RepositoryResponse<bool>> InitLanguages([FromBody] List<MixLan
/// </summary>
/// <param name="model"></param>
/// <returns></returns>
[HttpPost, HttpOptions]
[HttpPost]
[Route("init-cms/step-3/active")]
[DisableRequestSizeLimit]
public async Task<ActionResult<bool>> Active([FromBody] Lib.ViewModels.MixThemes.UpdateViewModel model)
Expand Down
10 changes: 5 additions & 5 deletions src/Mix.Cms.Api/Controllers/v1/ApiMediaController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public ApiMediaController(MixCmsContext context, IMemoryCache memoryCache, Micro
#region Get

// GET api/media/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("delete/{id}")]
public async Task<RepositoryResponse<MixMedia>> DeleteAsync(int id)
{
Expand All @@ -42,7 +42,7 @@ public async Task<RepositoryResponse<MixMedia>> DeleteAsync(int id)
}

// GET api/medias/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("details/{id}/{viewType}")]
[Route("details/{viewType}")]
public async Task<ActionResult<JObject>> Details(string viewType, int? id)
Expand Down Expand Up @@ -78,7 +78,7 @@ public async Task<ActionResult<JObject>> Details(string viewType, int? id)
#region Post

// POST api/media
[HttpPost, HttpOptions]
[HttpPost]
[Route("save")]
public async Task<RepositoryResponse<UpdateViewModel>> Save([FromForm] string model, [FromForm] IFormFile file)
{
Expand Down Expand Up @@ -116,7 +116,7 @@ public async Task<RepositoryResponse<UpdateViewModel>> UploadMedia([FromForm] IF
}

// GET api/media
[HttpPost, HttpOptions]
[HttpPost]
[Route("list")]
public async Task<ActionResult<JObject>> GetList(
[FromBody] RequestPaging request)
Expand Down Expand Up @@ -146,7 +146,7 @@ public async Task<ActionResult<JObject>> GetList(
}

// POST api/update-infos
[HttpPost, HttpOptions]
[HttpPost]
[Route("update-infos")]
public async Task<RepositoryResponse<List<UpdateViewModel>>> UpdateInfos([FromBody] List<UpdateViewModel> models)
{
Expand Down
10 changes: 5 additions & 5 deletions src/Mix.Cms.Api/Controllers/v1/ApiMixDatabaseColumnController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public ApiMixDatabaseColumnController(MixCmsContext context, IMemoryCache memory
#region Get

// GET api/mix-database-column/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("delete/{id}")]
public async Task<RepositoryResponse<MixDatabaseColumn>> DeleteAsync(int id)
{
Expand All @@ -44,7 +44,7 @@ public async Task<RepositoryResponse<MixDatabaseColumn>> DeleteAsync(int id)
}

// GET api/mix-database-columns/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("details/{id}/{viewType}")]
[Route("details/{viewType}")]
public async Task<ActionResult<JObject>> Details(string viewType, int? id)
Expand Down Expand Up @@ -95,7 +95,7 @@ public async Task<ActionResult<JObject>> Details(string viewType, int? id)

// GET api/module-data/create/id
[AllowAnonymous]
[HttpGet, HttpOptions]
[HttpGet]
[Route("init-form/{setId}")]
public async Task<RepositoryResponse<List<UpdateViewModel>>> InitByName(int setId)
{
Expand All @@ -109,7 +109,7 @@ public async Task<RepositoryResponse<List<UpdateViewModel>>> InitByName(int setI

// POST api/mix-database-column
[Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "SuperAdmin, Admin")]
[HttpPost, HttpOptions]
[HttpPost]
[RequestFormSizeLimit(valueCountLimit: 214748364)] // 200Mb
[Route("save")]
public async Task<RepositoryResponse<UpdateViewModel>> Save(UpdateViewModel data)
Expand All @@ -129,7 +129,7 @@ public async Task<RepositoryResponse<UpdateViewModel>> Save(UpdateViewModel data
}

// GET api/mix-database-column
[HttpPost, HttpOptions]
[HttpPost]
[Route("list")]
public async Task<ActionResult<JObject>> GetList(
[FromBody] RequestPaging request)
Expand Down
8 changes: 4 additions & 4 deletions src/Mix.Cms.Api/Controllers/v1/ApiMixDatabaseController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public ApiMixDatabaseController(MixCmsContext context, IMemoryCache memoryCache,
#region Get

// GET api/mix-database/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("delete/{id}")]
public async Task<RepositoryResponse<MixDatabase>> DeleteAsync(int id)
{
Expand All @@ -42,7 +42,7 @@ public async Task<RepositoryResponse<MixDatabase>> DeleteAsync(int id)
}

// GET api/mix-databases/id
[HttpGet, HttpOptions]
[HttpGet]
[Route("details/{id}/{viewType}")]
[Route("details/{name}/{viewType}")]
[Route("details/{viewType}")]
Expand Down Expand Up @@ -98,7 +98,7 @@ public async Task<ActionResult<JObject>> Details(string viewType, string name, i

// POST api/mix-database
[Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "SuperAdmin, Admin")]
[HttpPost, HttpOptions]
[HttpPost]
[Route("save")]
public async Task<RepositoryResponse<UpdateViewModel>> Save([FromBody] UpdateViewModel data)
{
Expand All @@ -117,7 +117,7 @@ public async Task<RepositoryResponse<UpdateViewModel>> Save([FromBody] UpdateVie
}

// GET api/mix-database
[HttpPost, HttpOptions]
[HttpPost]
[Route("list")]
public async Task<ActionResult<JObject>> GetList(
[FromBody] RequestPaging request)
Expand Down
Loading
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载