Unionj-generator is a collection of code generators for spring boot applications with a built-in RESTful api design tool(DSL) compatible with OpenAPI 3.0.0 specification.
Including：
- backend: Using dsl or OpenAPI 3.0 json doc to generate vo, proto, controller, service and feign modules for spring boot backend
- openapi: dsl implementing OpenAPI 3.0.0 specification
- ui: OpenAPI3 documentation web UI
- maven plugin: maven command line command to generate backend code
<dependencies>
<dependency>
<groupId>io.github.unionj-cloud</groupId>
<artifactId>unionj-generator-backend</artifactId>
<version>1.6.7</version>
</dependency>
<dependency>
<groupId>io.github.unionj-cloud</groupId>
<artifactId>unionj-generator-openapi</artifactId>
<version>1.6.7</version>
</dependency>
<dependency>
<groupId>io.github.unionj-cloud</groupId>
<artifactId>unionj-generator-ui</artifactId>
<version>1.6.7</version>
</dependency>
</dependencies><build>
<plugins>
<plugin>
<groupId>io.github.unionj-cloud</groupId>
<artifactId>unionj-generator-maven-plugin</artifactId>
<version>1.6.7</version>
<inherited>false</inherited>
<executions>
<execution>
<id>petStore</id>
<goals>
<goal>codegen</goal>
</goals>
<inherited>false</inherited>
<configuration>
<docUrl>https://petstore3.swagger.io/api/v3/openapi.json</docUrl>
<feignPkg>io.github.unionj-cloud.feign</feignPkg>
<feignDir>${project.basedir}/cloud-petStore-feign</feignDir>
<voPkg>io.github.unionj-cloud.vo</voPkg>
<voDir>${project.basedir}/cloud-petStore-vo</voDir>
<packages>
<package>FEIGN</package>
<package>VO</package>
</packages>
<serviceId>cloud-petStore</serviceId>
<serviceBaseUrlKey>petStore.baseUrl</serviceBaseUrlKey>
</configuration>
</execution>
</executions>
<configuration>
<parentGroupId>io.github.unionj-cloud</parentGroupId>
<parentArtifactId>cloud-unionj</parentArtifactId>
<parentVersion>1.0.0-SNAPSHOT</parentVersion>
</configuration>
</plugin>
</plugins>
</build>
It's a simple typescript http client code download restful service project. Upload OpenAPI3 spec json file, download ts code. It's used in our company project.
Repo: https://github.com/unionj-cloud/openapi-svc
Screenshot:
Repo: https://github.com/unionj-cloud/unionj-generator-guide
import static cloud.unionj.generator.OpenAPI3.dsl.Schema.schema;
import static cloud.unionj.generator.OpenAPI3.dsl.SchemaHelper.*;
public class Components {
private static Schema sizeProperty = int32("每页条数，默认10，传-1查出全部数据");
private static Schema currentProperty = int32("当前页，从1开始");
private static Schema offsetProperty = int32("偏移量");
private static Schema sortProperty = string("排序条件字符串：排序字段前使用'-'(降序)和'+'(升序)号表示排序规则，多个排序字段用','隔开",
"+id,-create_at");
private static Schema pageProperty = int32("当前页，从1开始");
private static Schema limitProperty = int32("每页条数，默认10, 传-1查出全部数据", 10);
private static Schema maxPageProperty = int32("导出结束页");
private static Schema totalProperty = int64("总数，入参传入此参数则不再查询count，以此total为准");
private static Schema topStatusProperty = int32("需要排在前的状态");
public static Schema PageResultVO = schema(sb -> {
// Schema type. Required.
sb.type("object");
// Schema title. Required. Otherwise the generator tool won't know it.
sb.title("PageResultVO");
// Generic as List<T>
sb.properties("items", ListT);
sb.properties("total", totalProperty);
sb.properties("size", sizeProperty);
sb.properties("current", currentProperty);
sb.properties("searchCount", bool);
sb.properties("pages", int32("当前分页总页数"));
sb.properties("offset", offsetProperty);
});
public static Schema RankVO = schema(sb -> {
sb.type("object");
sb.title("RankVO");
sb.description("排行榜");
sb.properties("serialNo", int32);
sb.properties("name", string);
sb.properties("income", doubleNumer("累计收入"));
sb.properties("quantity", int32("完成任务数量"));
});
public static Schema PageResultVOJobVO = generic(gb -> {
gb.generic(PageResultVO, ref(RankVO.getTitle()));
});
}There are some built-in schemas in cloud.unionj.generator.OpenAPI3.dsl.SchemaHelper.
| Type | Java |
|---|---|
| int32 | Integer |
| int64 | Long |
| string | String |
| bool | Boolean |
| floatNumber | Float |
| doubleNumer | Double |
| dateTime | java.util.Date |
| T | |
| ListT | List |
| SetT | Set |
| stringArray | List |
| int32Array | List |
| int64Array | List |
| floatArray | List |
| doubleArray | List |
| boolArray | List |
| dateTimeArray | List<java.util.Date> |
| enums | enum |
| ref | Object |
| refArray | List |
// PageResultVO must has and only has one T like field, e.g. T, List<T>, Set<T>
// It will be represented as PageResultVO<RankVO>
public static Schema PageResultVOJobVO = generic(gb -> {
gb.generic(PageResultVO, ref(RankVO.getTitle()));
});import static cloud.unionj.generator.OpenAPI3.PathHelper.*;
@Test
public void TestPath() throws IOException {
OpenAPI3 OpenAPI3 = OpenAPI3(ob -> {
info(ib -> {
ib.title("title");
ib.version("v1.0.0");
});
server(sb -> {
sb.url("http://unionj.cloud");
});
// Support GET, POST, PUT, DELETE only.
post("/hall/onlineSurvey/list", PathConfig.builder()
.summary("summary")
.tags(new String[]{"tag1", "tag2"})
.reqSchema(SearchJobPageResult)
.respSchema(SearchJobPageResult)
.build());
post("/hall/offlineSurvey/update", PathConfig.builder()
.summary("summary")
// Second tag will be used as Proto or typescript Service name
// If there was only one tag, the Proto or typescript Service name will be first part of endpoint
// e.g. HallProto, HallService
.tags(new String[]{"tag1", "HallOfflinesurvey"})
.reqSchema(SearchJobPageResult)
.respSchema(SearchJobPageResult)
.build());
post("/admin/onlineSurvey/top/update", PathConfig.builder()
.summary("summary")
.tags(new String[]{"tag1"})
.parameters(new Parameter[]{
ParameterBuilder.builder().name("id").in(Parameter.InEnum.QUERY).required(true).schema(string).build(),
ParameterBuilder.builder().name("top").in(Parameter.InEnum.QUERY).required(true).schema(int32).build(),
})
.respSchema(SearchJobPageResult)
.build());
});
Backend backend = BackendDocParser.parse(OpenAPI3);
SpringbootFolderGenerator springbootFolderGenerator = new SpringbootFolderGenerator.Builder(backend).build();
springbootFolderGenerator.generate();
}package cloud.unionj.example.proto;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import java.util.*;
import cloud.unionj.example.vo.*;
import cloud.unionj.example.es.page.PageResult;
public interface AdminProto {
@PostMapping("/admin/news/list")
ResultDTO<PageResultVO<NewsVO>> postAdminNewsList(
@RequestBody BaseSearchCondition body
);
}- Source code in proto package, vo package and controller package will be replaced with new code completely, so don't edit any source code in these packages.
- Existing source code in service package will be skipped and not be changed, so you can edit or add your custom code.
Please reference unionj-generator kanban
- go-doudou: OpenAPI 3.0 spec based lightweight microservice framework for Go
- pullcode: a typescript http client code generation cli compatible with Swagger 2 and OpenAPI 3
Welcome to contribute to unionj-generator by forking it and submitting pr or issues. If you like unionj-generator, please give it a star!
Welcome to contact me from
- facebook: https://www.facebook.com/bin.wu.94617999/
- twitter: https://twitter.com/BINWU49205513
- email: [email protected]
- wechat:
