Skip to content

Commit 13012e6

Browse files
author
FalkWolsky
committed
Enabled better Sorting of OpenAPI Spec Document
1 parent 32c0253 commit 13012e6

File tree

2 files changed

+39
-2
lines changed

2 files changed

+39
-2
lines changed

server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/OpenAPIDocsConfiguration.java

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,48 @@ public OpenAPI customizeOpenAPI() {
5252
.description("Lowcoder Community Edition: Public Cloud API Access"))
5353
.addSecurityItem(new SecurityRequirement().addList(securitySchemeName))
5454
.components(new Components()
55-
.addSecuritySchemes("API Key", new SecurityScheme()
55+
.addSecuritySchemes("APIKey", new SecurityScheme()
5656
.name("Authorization")
5757
.type(SecurityScheme.Type.APIKEY)
5858
.in(SecurityScheme.In.HEADER)
5959
.scheme("bearer")
6060
.bearerFormat("JWT")
61-
.description("API Key Authentication with a Bearer token. Copy your API Key and prefix it here with 'Bearer ' (e.g. 'Bearer eyJhbGciO...')")));
61+
.description("API Key Authentication with a Bearer token. Copy your API Key and prefix it here with 'Bearer ' (e.g. 'Bearer eyJhbGciO...')"))
62+
63+
)
64+
.tags(Arrays.asList(
65+
new Tag().name("API Root Endpoint").description("API Root Endpoint"),
66+
new Tag().name("Application APIs").description("Application APIs"),
67+
new Tag().name("Application History APIs").description("Application History APIs"),
68+
new Tag().name("Application Permissions APIs").description("Application Permissions APIs"),
69+
new Tag().name("Application Record APIs").description("Application Record APIs"),
70+
new Tag().name("Authentication APIs").description("Authentication APIs"),
71+
new Tag().name("Bundle APIs").description("Bundle APIs"),
72+
new Tag().name("Bundle Permissions APIs").description("Bundle Permissions APIs"),
73+
new Tag().name("Configuration APIs").description("Configuration APIs"),
74+
new Tag().name("Data Source APIs").description("Data Source APIs"),
75+
new Tag().name("Data Source Permissions APIs").description("Data Source Permissions APIs"),
76+
new Tag().name("File APIs").description("File APIs"),
77+
new Tag().name("Folder APIs").description("Folder APIs"),
78+
new Tag().name("Folder Permissions APIs").description("Folder Permissions APIs"),
79+
new Tag().name("Group APIs").description("Group APIs"),
80+
new Tag().name("Group Members APIs").description("Group Members APIs"),
81+
new Tag().name("Image Assets APIs").description("Image Assets APIs"),
82+
new Tag().name("Javascript Library APIs").description("Javascript Library APIs"),
83+
new Tag().name("Library Queries Record APIs").description("Library Queries Record APIs"),
84+
new Tag().name("Meta APIs").description("Meta APIs"),
85+
new Tag().name("Organization APIs").description("Organization APIs"),
86+
new Tag().name("Organization Member APIs").description("Organization Member APIs"),
87+
new Tag().name("Private NPM registry APIs").description("Private NPM registry APIs"),
88+
new Tag().name("Query Execution APIs").description("Query Execution APIs"),
89+
new Tag().name("Query Library APIs").description("Query Library APIs"),
90+
new Tag().name("Server Setting APIs").description("Server Setting APIs"),
91+
new Tag().name("Status checks APIs").description("Status checks APIs"),
92+
new Tag().name("User APIs").description("User APIs"),
93+
new Tag().name("User Password APIs").description("User Password APIs"),
94+
new Tag().name("User Profile Photo APIs").description("User Profile Photo APIs"),
95+
new Tag().name("User invitation APIs").description("User invitation APIs")
96+
));
6297
}
6398

6499
/**

server/api-service/lowcoder-server/src/main/resources/application.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ springdoc:
105105
path: /api/docs/openapi.json
106106
swagger-ui:
107107
path: /api/docs/swagger-ui
108+
operations-sorter: method
109+
tags-sorter: alpha
108110
paths-to-exclude: /api/v1/**
109111

110112
management:

0 commit comments

Comments
 (0)