kouweizhong/abp.web.api.swaggertool

powerful swagger

Abp.Web.Api.SwaggerTool

Feature

1 codegen C# and js

/swagger/proxy/CSharp
/swagger/proxy/JQueryCallbacks
/swagger/proxy/JQueryPromises
/swagger/proxy/AngularJS
/swagger/proxy/Angular2

2 export json file that can import into POSTMEN ,better than the import function buildin POSTMEN

/swagger/postman

3 can search in the swagger-ui

/swagger/docs/{apiVersion}/{key to search by path}

4 automatic api changelogs and backwards compatible status

/sawgger/changelogs/{apiVersion}

5 six swagger-ui theme (https://github.com/ostranme/swagger-ui-themes)
6 hide api or Abp api in the swagger

#setting file

{
  "enable": true, //是否启用swagger集成  
  "theme": "flattop", //主题名称 flattop，muted，newspaper，outline，monokai，feeling-blue  
  "HideAbpAutogeneratedApi": false, //是否隐藏Abp框架生成的Api接口  
  "HideDocPathAttributeName": "XX", //Api上标注此特性的话，则不在swagger中生成  
  "HideDocPaths": ["path1"],//Api中包含这些字符，则不在swagger中生成  
  "CSharpGen": {
    "ClassName": "ApiClient", //C#代理生成的类名  
    "Namespace": "ApiServices" //C#代理生成的命名空间  
  },
  "TypeScriptGen": { 
    "ClassName": "Client", //JS代理生成的类名  
    "Namespace": "ApiServices" //JS代理生成的命名空间  
  },
  "PostmanGen": {  
    "name": "ApiServices" //名称  
  },
  "XmlCommentFiles": ["xxx.xml"]//xml注释的文件名  
}