Background
When I was developing foundational RESTful APIs (Web API) for one of our clients, swagger was our choice for documentation. Swagger provides interactive documentation feature with nice UI. Since we were developing only RESTful APIs, QA team members were using Swagger UI to test APIs.
Suddenly there was a request from customer to disable swagger in production environment.
Solution
How to enable swagger?
- Install "Swashbuckle" nuget package into your WebAPI project.
- This installation will add the following entries in "packages.config"
<package id="Swashbuckle" version="5.5.3" targetFramework="net45" />
<package id="Swashbuckle.Core" version="5.5.3" targetFramework="net45" />
- "SwaggerConfig.cs" file will be added in "App_Start" folder
- Execute the project code. When the new browser window pops out, add "swagger/ui/index" at the end the URI. It will load swagger documentation UI.
Ex:
When I run my sample application, it opens up a new browser window with url "http://localhost/SwaggerDoc/"
When I add "swagger/ui/index" at the end of the URI. (i.e)
Here, I have only "Values" controller with one method "/api/Values".
How to disable swagger?
As soon as "Swashbuckle" package is added with the WebAPI project, by default swagger documentation will be enabled. Swagger doesn't have a built-in property to disable it.
"SwaggerConfig.cs" (inside "App_Start" folder) is responsible for enabling swagger. So I have added a new entry in web.config file to control this.
<add key="DisableSwagger" value="True" />
</appSettings>
Based on this key "DisableSwagger" value, either swagger documentation will be enabled or disabled.
Added the following lines in "SwaggerConfig.cs" file inside "public static void Register()" method.
{
return;
}
Based on the environment, value of "DisableSwagger" key can be controlled using config file transformation.
Ex:
I have added the following entry in "Web.Production.config"
<add key="DisableSwagger" value="True" xdt:Transform="Replace" xdt:Locator="Match(key)" />
"Web.Production.config" and "Web.Staging.config" files has
<add key="DisableSwagger" value="False" xdt:Transform="Replace" xdt:Locator="Match(key)" />
To disable Swagger documentation working with hapijs you can follow these steps or go-through this link "https://stackoverflow.com/questions/48960774/how-to-disable-swagger-api-documentation-from-production-server-in-hapijs/48960775#48960775"
ReplyDeleteStep 1. Go to the path
project_directory/node_modules/hapi-swagger/public/lib/index.js
Step 2. Open index.js and here you will find internal default options as below:
var internals = {
defaults: {
protocol: null, // If not specified, uses the same protocol as server info
endpoint: '/docs',
documentationPath: '/documentation',
enableDocumentationPage: true,
auth: false,
basePath: '',
pathPrefixSize: 1,
payloadType: 'json',
produces: ['application/json'],
consumes: ['application/json'],
ui: true,
listing: true,
index: false,
customJSHandler: function(request, reply) {
reply('').type('application/javascript');
},
}
};
Step 3. Replace enableDocumentationPage options from true to false.
Step 4. Finally restart you project either with pm2 restart or with node server.js and now try to run swagger API documentation. You will see now it is throwing 404 which means you successfully disabled your API doc.