Skip to content

feat(server):swagger support auth for standardAuth mode #2360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simon824 merged 2 commits into from
Nov 28, 2023
Merged

feat(server):swagger support auth for standardAuth mode #2360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ec394b
feat(server):swagger support auth for standardAuth mode and try to fi…
SunnyBoy-WYH Nov 22, 2023
f431efc
chore(api): update api version & swagger token auth mode
SunnyBoy-WYH Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...ver/hugegraph-api/src/main/java/org/apache/hugegraph/api/filter/AuthenticationFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ public class AuthenticationFilter implements ContainerRequestFilter {

private static final List<String> WHITE_API_LIST = ImmutableList.of(
"auth/login",
"versions"
"versions",
"openapi.json"
Copy link
Member

@imbajin imbajin Nov 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we add swagger file to white_list by default to allow normal users to check the api & not locked by auth

);

private static String whiteIpStatus;
Expand Down
16 changes: 15 additions & 1 deletion ...aph-server/hugegraph-api/src/main/java/org/apache/hugegraph/server/ApplicationConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,30 @@
import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Contact;
import io.swagger.v3.oas.annotations.info.Info;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.security.SecurityScheme;
import jakarta.ws.rs.ApplicationPath;

@SecurityScheme(
name = "basic",
type = SecuritySchemeType.HTTP,
scheme = "basic"
)
@SecurityScheme(
name = "bearer",
type = SecuritySchemeType.HTTP,
scheme = "bearer"
)
@ApplicationPath("/")
@OpenAPIDefinition(
info = @Info(
title = "HugeGraph RESTful API",
version = CoreVersion.DEFAULT_VERSION,
description = "All management API for HugeGraph",
contact = @Contact(url = "https://github.com/apache/hugegraph", name = "HugeGraph")
)
),
security = {@SecurityRequirement(name = "basic"), @SecurityRequirement(name = "bearer")}
)
public class ApplicationConfig extends ResourceConfig {

Expand Down
4 changes: 3 additions & 1 deletion hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/version/ApiVersion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,14 @@ public final class ApiVersion {
* [0.67] Issue-1065: Support dynamically add/remove graph
* [0.68] Issue-1763: Support adamic-adar & resource-allocation API
* [0.69] Issue-1748: Support Cypher query RESTful API
* [0.70] Issue-2242: Optimising adjacency edge queries
* [0.71] PR-2286: Support Arthas API & Metric API prometheus format
*/

/**
* The second parameter of Version.of() is for IDE running without JAR
*/
public static final Version VERSION = Version.of(ApiVersion.class, "0.69");
public static final Version VERSION = Version.of(ApiVersion.class, "0.71");

public static void check() {
// Check version of hugegraph-core. Firstly do check from version 0.3
Expand Down
7 changes: 1 addition & 6 deletions hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/ArthasApiTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,7 @@ public void testArthasStart() {
public void testArthasApi() {
String body = "{\n" +
" \"action\": \"exec\",\n" +
" \"requestId\": \"req112\",\n" +
" \"consumerId\": \"955dbd1325334a84972b0f3ac19de4f7_2\",\n" +
" \"command\": \"version\",\n" +
" \"execTimeout\": \"10000\"\n" +
" \"command\": \"version\"\n" +
"}";
RestClient arthasApiClient = new RestClient(ARTHAS_API_BASE_URL, false);
// If the request header contains basic auth,
Expand All @@ -52,8 +49,6 @@ public void testArthasApi() {
Response r = arthasApiClient.post(ARTHAS_API_PATH, body);
String result = assertResponseStatus(200, r);
assertJsonContains(result, "state");
assertJsonContains(result, "requestId");
assertJsonContains(result, "sessionId");
assertJsonContains(result, "body");

RestClient arthasApiClientWithAuth = new RestClient(ARTHAS_API_BASE_URL);
Expand Down