Appearance
主题定义
| 主题名 | Topic | 发送者->订阅者 | 说明 | |
|---|---|---|---|---|
| 1 | 设备注册 | iot/register | 设备->云平台 | |
| 2 | 设备注册回复 | iot/register_reply | 云平台->设备 |
协议定义
设备注册
| 业务ID | text | uuid唯一的业务id | |
| random | 随机数 | int |
| 业务ID | text | 设备注册时传入的uuid | |
| 结果码 | int | 0:成功 1:失败 | |
| SN编码 | text | 设备SN编码 | |
| 16字节注册编码 | |||
| 随机数 | int |
示例
json
设备发送:
{
"hmac":"asdfa23423423424asdfasdfasdgsdfg34452342342342",
"bid":"ab734e1e-7011-3af2-97bd-2e5148443fb6",
"random":123586
}
云平台回复:
{
"hmac":"asdfa23423423424asdfasdfasdgsdfg34452342342342",
"bid":"ab734e1e-7011-3af2-97bd-2e5148443fb6",
"code":0,
"sn":"A234B445C4545",
"register_id":"asdfa23423423424asdfasdfasdgsdfg34452342342342",
"random":12358634
}
设备确认:
{
"hmac":"asdfa23423423424asdfasdfasdgsdfg34452342342342",
"bid":"ab734e1e-7011-3af2-97bd-2e5148443fb6",
"code":0,
"random":1233435
}java
@Configuration
public class SwaggerConfig
{
/** 系统基础配置 */
@Autowired
private RuoYiConfig ruoyiConfig;
/** 是否开启swagger */
@Value("${swagger.enabled}")
private boolean enabled;
/** 设置请求的统一前缀 */
@Value("${swagger.pathMapping}")
private String pathMapping;
/**
* 创建API
*/
@Bean
public Docket createRestApi()
{
return new Docket(DocumentationType.OAS_30)
// 是否启用Swagger
.enable(enabled)
// 用来创建该API的基本信息,展示在文档的页面中(自定义展示的信息)
.apiInfo(apiInfo())
// 设置哪些接口暴露给Swagger展示
.select()
// 扫描所有有注解的api,用这种方式更灵活
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
// 扫描指定包中的swagger注解
// .apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
// 扫描所有 .apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
/* 设置安全模式,swagger可以设置访问token */
.securitySchemes(securitySchemes())
.securityContexts(securityContexts())
.pathMapping(pathMapping);
}
/**
* 安全模式,这里指定token通过Authorization头请求头传递
*/
private List<SecurityScheme> securitySchemes()
{
List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();
apiKeyList.add(new ApiKey("Authorization", "Authorization", In.HEADER.toValue()));
return apiKeyList;
}
/**
* 安全上下文
*/
private List<SecurityContext> securityContexts()
{
List<SecurityContext> securityContexts = new ArrayList<>();
securityContexts.add(
SecurityContext.builder()
.securityReferences(defaultAuth())
.operationSelector(o -> o.requestMappingPattern().matches("/.*"))
.build());
return securityContexts;
}
/**
* 默认的安全上引用
*/
private List<SecurityReference> defaultAuth()
{
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
List<SecurityReference> securityReferences = new ArrayList<>();
securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
return securityReferences;
}
/**
* 添加摘要信息
*/
private ApiInfo apiInfo()
{
// 用ApiInfoBuilder进行定制
return new ApiInfoBuilder()
// 设置标题
.title("标题:若依管理系统_接口文档")
// 描述
.description("描述:用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...")
// 作者信息
.contact(new Contact(ruoyiConfig.getName(), null, null))
// 版本
.version("版本号:" + ruoyiConfig.getVersion())
.build();
}
}