我在正在进行的项目中实施了同样的事情。我们可以下载所有API的PDF文档。我已经使用 Rapi-Pdf 插件完成了,通过它我们可以生成 swagger Json 的 PDF。它位于 Dotnet core 2.1 中。
这是我的下面的代码,我们需要在startup.cs文件中配置它。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseStaticFiles();
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint(Configuration["Swagger:swaggerurl"], Configuration["Swagger:swaggertitle"]);
c.InjectJavascript("/swagger-ui/custom.js");
c.InjectJavascript("/swagger-ui/rapipdf-min.js");
});
if (env.IsDevelopment())
{
_logger.LogInformation("Configuring for Development environment");
app.UseDeveloperExceptionPage();
}
else
{
_logger.LogInformation("Configuring for Production environment");
app.UseHsts();
}
app.UseAuthentication();
app.UseMiddleware<ErrorHandlerMiddleware>();
//removed middleware to handle token, now changed with policies and auth schemes
//app.UseMiddleware<TokenManagerMiddleware>();
app.UseHttpsRedirection();
app.UseMvc();
}
在上面的代码中,我们需要理解的是,我们必须注入两个js文件,一个是自定义js,另一个是插件,因此它将添加到Swagger UI索引页面的head部分。
这是我的下面的代码,位于 Custom.js 中
window.addEventListener("load", function () {
customizeSwaggerUI();
});
function customizeSwaggerUI() {
setTimeout(function () {
var tag = '<rapi-pdf style="display:none" id="thedoc"> </rapi-pdf>';
var btn = '<button id="btn" style="font-size:16px;padding: 6px 16px;text-align: center;white-space: nowrap;background-color: orangered;color: white;border: 0px solid #333;cursor: pointer;" type="button" onclick="downloadPDF()">Download API Document </button>';
var oldhtml = document.getElementsByClassName('info')[0].innerHTML;
document.getElementsByClassName('info')[0].innerHTML = oldhtml + '</br>' + tag + '</br>' + btn;
}, 1200);
}
function downloadPDF() {
var client = new XMLHttpRequest();
client.overrideMimeType("application/json");
client.open('GET', 'v1/swagger.json');
var jsonAPI = "";
client.onreadystatechange = function () {
if (client.responseText != 'undefined' && client.responseText != "") {
jsonAPI = client.responseText;
if (jsonAPI != "") {
let docEl = document.getElementById("thedoc");
var key = jsonAPI.replace('\"Authorization: Bearer {token}\"', "");
let objSpec = JSON.parse(key);
docEl.generatePdf(objSpec);
}
}
}
client.send();
}
就是这样。现在您可以下载 PDF 格式的 API 文档。
希望这将帮助某人集成相同类型的功能。