private SecuritySchemeDefinition getSecuritySchemeDefinitionByType(String type, JsonNode node) throws GenerateException { try { SecuritySchemeDefinition def = null; if (type.equals(new OAuth2Definition().getType())) { def = new OAuth2Definition(); if (node != null) { def = mapper.readValue(node.traverse(), OAuth2Definition.class); } } else if (type.equals(new BasicAuthDefinition().getType())) { def = new BasicAuthDefinition(); if (node != null) { def = mapper.readValue(node.traverse(), BasicAuthDefinition.class); } } else if (type.equals(new ApiKeyAuthDefinition().getType())) { def = new ApiKeyAuthDefinition(); if (node != null) { def = mapper.readValue(node.traverse(), ApiKeyAuthDefinition.class); } } return def; } catch (IOException e) { throw new GenerateException(e); } }
public static BasicAuthDefinition basicAuth() { return new BasicAuthDefinition(); } public static ApiKeyAuthDefinition apiKeyAuth(String name, In in) {
@Override public void afterScan(Reader reader, Swagger swagger) { swagger.addSecurityDefinition(TOKEN_AUTH_SCHEME, new BasicAuthDefinition()); swagger.getPaths().values() .stream() .forEach( path -> path.getOperations() .stream() .forEach( operation -> operation.addSecurity(GraviteeApiDefinition.TOKEN_AUTH_SCHEME, null))); } }
@Override public void afterScan(Reader reader, Swagger swagger) { swagger.addSecurityDefinition(TOKEN_AUTH_SCHEME, new BasicAuthDefinition()); swagger.getPaths().values() .stream() .forEach( path -> path.getOperations() .stream() .forEach( operation -> operation.addSecurity(GraviteeApiDefinition.TOKEN_AUTH_SCHEME, null))); } }
@Override public void beforeScan(final io.swagger.jaxrs.Reader reader, final Swagger swagger) { BasicAuthDefinition basicAuthDefinition = new BasicAuthDefinition(); swagger.addSecurityDefinition(BASIC_AUTH_SCHEME, basicAuthDefinition); ApiKeyAuthDefinition xKillbillApiKey = new ApiKeyAuthDefinition("X-Killbill-ApiKey", In.HEADER); swagger.addSecurityDefinition(API_KEY_SCHEME, xKillbillApiKey); ApiKeyAuthDefinition xKillbillApiSecret = new ApiKeyAuthDefinition("X-Killbill-ApiSecret", In.HEADER); swagger.addSecurityDefinition(API_SECRET_SCHEME, xKillbillApiSecret); }
protected Swagger2Feature createSwagger2Feature() { final Swagger2Feature feature = new Swagger2Feature(); feature.setRunAsFilter(runAsFilter); feature.setPropertiesLocation("/files/swagger.properties"); feature.setSecurityDefinitions(Collections.singletonMap(SECURITY_DEFINITION_NAME, new io.swagger.models.auth.BasicAuthDefinition())); return feature; } }
/** * Adds the swagger. */ private void addSwagger() { Swagger2Feature feature = new Swagger2Feature(); // customize some of the properties feature.setBasePath("/services/v3"); feature.setPrettyPrint(true); feature.setDescription("Eclipse Dirigible API of the core RESTful services provided by the application development platform itself"); feature.setVersion("3.0"); feature.setTitle("Eclipse Dirigible - RESTful Services API"); feature.setContact("dirigible-dev@eclipse.org"); feature.setLicense("Eclipse Public License - v 1.0"); feature.setLicenseUrl("https://www.eclipse.org/legal/epl-v10.html"); Map<String, SecuritySchemeDefinition> securityDefinitions = new HashMap<String, SecuritySchemeDefinition>(); BasicAuthDefinition auth = new BasicAuthDefinition(); auth.setType("basic"); securityDefinitions.put("basicAuth", auth); feature.setSecurityDefinitions(securityDefinitions); feature.setPrettyPrint(true); getServices().add(feature); }
/** * Adds the swagger. */ private void addSwagger() { Swagger2Feature feature = new Swagger2Feature(); // customize some of the properties feature.setBasePath("/services/v3"); feature.setPrettyPrint(true); feature.setDescription("Eclipse Dirigible API of the core RESTful services provided by the application development platform itself"); try { Version version = new VersionProcessor().getVersion(); feature.setVersion(version.getProductVersion()); } catch (IOException e) { logger.error(e.getMessage(), e); feature.setVersion("3.0.0"); } feature.setTitle("Eclipse Dirigible - RESTful Services API"); feature.setContact("dirigible-dev@eclipse.org"); feature.setLicense("Eclipse Public License - v 1.0"); feature.setLicenseUrl("https://www.eclipse.org/legal/epl-v10.html"); Map<String, SecuritySchemeDefinition> securityDefinitions = new HashMap<String, SecuritySchemeDefinition>(); BasicAuthDefinition auth = new BasicAuthDefinition(); auth.setType("basic"); securityDefinitions.put("basicAuth", auth); feature.setSecurityDefinitions(securityDefinitions); feature.setPrettyPrint(true); getServices().add(feature); }
/** * Register authentication security. * * @param swagger * @param operation * @param method */ protected void registerSecurity(Swagger swagger, Operation operation, Method method) { RequireToken requireToken = ClassUtil.getAnnotation(method, RequireToken.class); if (requireToken != null) { String apiKeyName = requireToken.value(); if (swagger.getSecurityDefinitions() == null || !swagger.getSecurityDefinitions().containsKey(apiKeyName)) { ApiKeyAuthDefinition security = new ApiKeyAuthDefinition(); security.setName(apiKeyName); security.setIn(In.HEADER); security.setType("apiKey"); swagger.addSecurityDefinition(apiKeyName, security); } operation.addSecurity(apiKeyName, Collections.emptyList()); } BasicAuth basicAuth = ClassUtil.getAnnotation(method, BasicAuth.class); if (basicAuth != null) { if (swagger.getSecurityDefinitions() == null || !swagger.getSecurityDefinitions().containsKey("basic")) { BasicAuthDefinition security = new BasicAuthDefinition(); swagger.addSecurityDefinition("basic", security); } operation.addSecurity("basic", Collections.emptyList()); } }
/** * Register authentication security. * * @param swagger * @param operation * @param method */ protected void registerSecurity(Swagger swagger, Operation operation, Method method) { RequireToken requireToken = ClassUtil.getAnnotation(method, RequireToken.class); if (requireToken != null) { String apiKeyName = requireToken.value(); if (swagger.getSecurityDefinitions() == null || !swagger.getSecurityDefinitions().containsKey(apiKeyName)) { ApiKeyAuthDefinition security = new ApiKeyAuthDefinition(); security.setName(apiKeyName); security.setIn(In.HEADER); security.setType("apiKey"); swagger.addSecurityDefinition(apiKeyName, security); } operation.addSecurity(apiKeyName, Collections.emptyList()); } BasicAuth basicAuth = ClassUtil.getAnnotation(method, BasicAuth.class); if (basicAuth != null) { if (swagger.getSecurityDefinitions() == null || !swagger.getSecurityDefinitions().containsKey("basic")) { BasicAuthDefinition security = new BasicAuthDefinition(); swagger.addSecurityDefinition("basic", security); } operation.addSecurity("basic", Collections.emptyList()); } }
protected Swagger2Feature createSwagger2Feature() { final Swagger2Feature feature = new Swagger2Feature(); feature.setContact(CONTACT); feature.setTitle(TITLE); feature.setDescription(DESCRIPTION); feature.setLicense(LICENSE); feature.setLicenseUrl(LICENSE_URL); feature.setSecurityDefinitions(Collections.singletonMap(SECURITY_DEFINITION_NAME, new io.swagger.models.auth.BasicAuthDefinition())); return feature; }
protected Swagger2Feature createSwagger2Feature() { final Swagger2Feature feature = new Swagger2Feature(); feature.setRunAsFilter(runAsFilter); feature.setContact(CONTACT); feature.setTitle(TITLE); feature.setDescription(DESCRIPTION); feature.setLicense(LICENSE); feature.setLicenseUrl(LICENSE_URL); feature.setSecurityDefinitions(Collections.singletonMap(SECURITY_DEFINITION_NAME, new io.swagger.models.auth.BasicAuthDefinition())); return feature; }
BasicAuthDefinition basicAuthDefinition = new BasicAuthDefinition();
return result; case BASIC: final BasicAuthDefinition result_1 = new BasicAuthDefinition(); this.setVendorExtensions(scheme, result_1); result_1.setType("basic");
@Test public void swaggerSerializeTest() { final Info info = new Info().version("1.0.0").title("Swagger WebServices REST"); Swagger swagger = new Swagger().info(info).securityDefinition("basicAuth", new BasicAuthDefinition()) .scheme(Scheme.HTTP).consumes("application/json").produces("application/json"); final Model patientModel = ModelConverters.getInstance().read(Patient.class).get("Patient"); swagger.addDefinition("Patient", patientModel); final String swaggerJson = Json.pretty(swagger); assertNotNull(swaggerJson); }
private void initSwagger() { final Info info = new Info() .version(OpenmrsConstants.OPENMRS_VERSION_SHORT) .title("OpenMRS API Docs") .description("OpenMRS RESTful API documentation generated by Swagger") .contact(new Contact().name("OpenMRS").url("http://openmrs.org")) .license(new License().name("MPL-2.0 w/ HD").url("http://openmrs.org/license")); swagger .info(info) .host(this.host) .basePath(this.basePath) .schemes(this.schemes) .securityDefinition("basic_auth", new BasicAuthDefinition()) .security(new SecurityRequirement().requirement("basic_auth")) .consumes("application/json") .produces("application/json") .externalDocs(new ExternalDocs() .description("Find more info on REST Module Wiki") .url("https://wiki.openmrs.org/x/xoAaAQ")); }
config.securityDefinition().basicAuthDefinions(), config.securityDefinition().basicAuthDefinitions() }) { for (BasicAuthDefinition basicAuthConfig : basicAuthConfigs) { io.swagger.models.auth.BasicAuthDefinition basicAuthDefinition = new io.swagger.models.auth.BasicAuthDefinition();
config.securityDefinition().basicAuthDefinitions() }) { for (BasicAuthDefinition basicAuthConfig : basicAuthConfigs) { io.swagger.models.auth.BasicAuthDefinition basicAuthDefinition = new io.swagger.models.auth.BasicAuthDefinition();
config.securityDefinition().basicAuthDefinitions() }) { for (BasicAuthDefinition basicAuthConfig : basicAuthConfigs) { io.swagger.models.auth.BasicAuthDefinition basicAuthDefinition = new io.swagger.models.auth.BasicAuthDefinition();
config.securityDefinition().basicAuthDefinions(), config.securityDefinition().basicAuthDefinitions() }) { for (BasicAuthDefinition basicAuthConfig : basicAuthConfigs) { io.swagger.models.auth.BasicAuthDefinition basicAuthDefinition = new io.swagger.models.auth.BasicAuthDefinition();