Hiding swagger documentation from the public

Open
#854 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
ruby

Research direction

The issue names the my_api/swagger_doc documentation endpoint but no repository file or test. Start by locating where that endpoint is defined and how Swagger documentation is served; done means the documentation is no longer publicly accessible, either through authentication or by being withheld.

Written by the indexing model from the issue text.

Description

I'm looking to protect the swagger documentation so that it isn't publicly accessible.

Any suggestions on how to either add authentication or prevent the my_api/swagger_doc documentation from being served up to the public?

Dominant language
Ruby
Stars
1.1k
Forks
479
Avg merge
2d 14h
Merged PRs (30d)
6

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.

More from ruby-grape/grape-swagger

All issues in ruby-grape/grape-swagger

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.