Skip to content
This repository has been archived by the owner on Sep 14, 2022. It is now read-only.

Basic Auth Implementation for swagger play #210

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Basic Auth Implementation for swagger play #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions play-2.6/swagger-play2/app/play/modules/swagger/PlayReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,13 @@ protected void readSwaggerConfig(Class<?> cls, SwaggerDefinition config) {
swagger.addSecurityDefinition(apiKeyAuthConfig.key(), apiKeyAuthDefinition);
}

for (BasicAuthDefinition basicAuthConfig:config.securityDefinition().basicAuthDefinitions()) {

io.swagger.models.auth.BasicAuthDefinition basicAuthDefinition = new io.swagger.models.auth.BasicAuthDefinition();
basicAuthDefinition.setDescription(basicAuthConfig.description());

swagger.addSecurityDefinition(basicAuthConfig.key(), basicAuthDefinition);
}

for (SwaggerDefinition.Scheme scheme : config.schemes()) {
if (scheme != SwaggerDefinition.Scheme.DEFAULT) {
Expand Down
2 changes: 1 addition & 1 deletion play-2.6/swagger-play2/test/PlayApiListingCacheSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ PUT /api/dog/api/:id testdata.DogController.add0(id:String)
swagger.get.getInfo.getTitle must beEqualTo(swaggerConfig.getTitle)
swagger.get.getInfo.getTermsOfService must beEqualTo(swaggerConfig.getTermsOfServiceUrl)
swagger.get.getInfo.getLicense.getName must beEqualTo(swaggerConfig.getLicense)
swagger.get.getSecurityDefinitions.size() must beEqualTo(2)
swagger.get.getSecurityDefinitions.size() must beEqualTo(3)

val pathDoc = swagger.get.getPaths.get("/document/{settlementId}/files/{fileId}/accept")
pathDoc.getOperations.size must beEqualTo(1)
Expand Down
17 changes: 14 additions & 3 deletions play-2.6/swagger-play2/test/testdata/CatController.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,21 @@ import play.api.mvc.{Action, Controller}
authorizationUrl = "/authorize",
scopes = Array(new Scope(name = "write_pets", description = "modify pets"))
)
)
),
basicAuthDefinitions = Array(new BasicAuthDefinition(key = "basic_auth"))
)
)
@Api(value = "/apitest/cats", description = "play with cats")
@Api(value = "/apitest/cats", description = "play with cats", authorizations = Array (
new Authorization(
value = "oauth2"
),
new Authorization(
value = "api_key"
),
new Authorization(
value = "basic_auth"
)
))
class CatController extends Controller {

@ApiOperation(value = "addCat1",
Expand Down Expand Up @@ -76,7 +87,7 @@ class CatController extends Controller {
@ApiOperation(value = "test issue #43",
nickname = "test issue #43_nick",
notes = "test issue #43_notes",
response = classOf[testdata.Cat],
response = classOf[Cat],
responseContainer = "List",
httpMethod = "GET")
@ApiImplicitParams(Array(
Expand Down