org.apache.servicecomb.registry.swagger

Class SwaggerLoader

java.lang.Object

org.apache.servicecomb.registry.swagger.SwaggerLoader

public class SwaggerLoader
extends Object

Constructor Summary

Constructors

Constructor and Description
SwaggerLoader()

Method Summary

Modifier and Type	Method and Description
static String	calcSchemaSummary(String schemaContent)
io.swagger.models.Swagger	loadFromMemory(String appId, String shortName, String schemaId)
io.swagger.models.Swagger	loadLocalSwagger(String appId, String shortName, String schemaId)
io.swagger.models.Swagger	loadSwagger(Microservice microservice, Collection<MicroserviceInstance> instances, String schemaId)
io.swagger.models.Swagger	registerSwagger(String appId, String shortName, String schemaId, Class<?> cls)
void	registerSwagger(String appId, String shortName, String schemaId, io.swagger.models.Swagger swagger)
void	registerSwagger(String microserviceName, String schemaId, io.swagger.models.Swagger swagger)
void	registerSwaggersInLocation(String swaggersLocation) register swaggers in the location to current microservice Scenes for contract first mode: 1.consumer manager manage some product, can only know product microservice names after deploy and can only register swagger after product registered in fact, consumers can load swagger from ServiceCenter so for consumer, this logic is not necessary, just keep it for compatible 2.producer deploy to different microservice name in different product can register swaggers in BootListener.onBeforeProducerProvider
void	registerSwaggersInLocation(String microserviceName, String swaggersLocation)
void	unregisterSwagger(String appId, String shortName, String schemaId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwaggerLoader

public SwaggerLoader()

Method Detail

calcSchemaSummary

public static String calcSchemaSummary(String schemaContent)

registerSwaggersInLocation

public void registerSwaggersInLocation(String swaggersLocation)

 register swaggers in the location to current microservice
 Scenes for contract first mode:
  1.consumer
    manager manage some product, can only know product microservice names after deploy
    and can only register swagger after product registered
    in fact, consumers can load swagger from ServiceCenter
    so for consumer, this logic is not necessary, just keep it for compatible
  2.producer
    deploy to different microservice name in different product
    can register swaggers in BootListener.onBeforeProducerProvider
 

Parameters:

swaggersLocation - eg. "test/schemas", will load all test/schemas/*.yaml

registerSwaggersInLocation

public void registerSwaggersInLocation(String microserviceName,
                                       String swaggersLocation)

registerSwagger

public void registerSwagger(String microserviceName,
                            String schemaId,
                            io.swagger.models.Swagger swagger)

registerSwagger

public io.swagger.models.Swagger registerSwagger(String appId,
                                                 String shortName,
                                                 String schemaId,
                                                 Class<?> cls)

registerSwagger

public void registerSwagger(String appId,
                            String shortName,
                            String schemaId,
                            io.swagger.models.Swagger swagger)

unregisterSwagger

public void unregisterSwagger(String appId,
                              String shortName,
                              String schemaId)

loadSwagger

public io.swagger.models.Swagger loadSwagger(Microservice microservice,
                                             Collection<MicroserviceInstance> instances,
                                             String schemaId)

loadLocalSwagger

public io.swagger.models.Swagger loadLocalSwagger(String appId,
                                                  String shortName,
                                                  String schemaId)

loadFromMemory

public io.swagger.models.Swagger loadFromMemory(String appId,
                                                String shortName,
                                                String schemaId)