This repository was archived by the owner on Feb 16, 2024. It is now read-only.
S2GRAPH-253: Swagger Doc and UI support #197
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As an initial PR, I've added swagger doc and UI support, and added API docs for the "admin" services for now; mutate and query services will come later.
How to test:
Build the project with
sbt package.Start the project in the target/apache-s2graph-0.2.1-SNAPSHOT-incubating-bin directory through
bin/start-s2graph.shcommand.Visit the Swagger UI at http://localhost:8000/api-docs/.
Expand "/admin/createService" and click on "Try it out" button.
Replace the body with the following and click on "Execute" button.
Check if the result is 201 with a JSON output and the status is "ok".
Check if the result is 201 with a JSON output and the status is "ok".
Check if the result is 201 with a JSON output and the status is "ok".
Check if the result is 201 with a JSON output and the status is "ok".
Check if the result is 200 with a JSON output.