abpframework / abpframework/abp

Disable/configure Swagger in settings

Open
#11,562 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

abp-module-setting-management enhancement
Dominant language
C#
Stars
14.4k
Forks
3.7k
Avg merge
15h 32m
Merged PRs (30d)
106

Description

It would be nice if there were settings to disable/hide/configure the Swagger API via settings, like here:

https://github.com/EngincanV/ABP-Hide-Swagger-Endpoint-Demo

Use cases would be to either hide it completely or just expose selected methods, or perhaps an option to hide all built in ABP related stuff, and then just control the exposure of your own methods using standard annotations.

Even if the build in methods etc. requires authentication, they still expose a lot of information about system configuration, setup etc. and also makes it harder to find just the few methods you might want to expose.

This is of course quite heavily dependent on what kind of technology is used, a frontend in Angular would naturally use more of the API than one in Blazor server etc. but perhaps you would want to hide it in Swagger even if it is still available etc.

Is there an option to just hide Swagger behind some password authentication or similar that plays nice with ABP in general?

Thanks.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked ABP-Hide-Swagger-Endpoint-Demo and the issue's requested use cases. Before implementation, clarify whether the intended outcome is hiding Swagger, requiring authentication, filtering methods, or excluding built-in ABP endpoints; done should be defined by the selected configuration behavior and its security implications.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.