feat: add swagger ui API explorer #5970
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wemeetagain
commented
Sep 20, 2023
| ): void { | ||
| server.route({ | ||
| url: route.url, | ||
| method: route.method, | ||
| handler: route.handler, | ||
| schema: route.schema, | ||
| // append the namespace as a tag for downstream consumption of our API schema, eg: for swagger UI | ||
| schema: {...route.schema, ...(namespace ? {tags: [namespace]} : undefined)}, |
There was a problem hiding this comment.
This was required in order to group paths by namespace.
It would be nice to be able to reuse more of the beacon API schema but 🤷 that seems like a larger refactor.
There was a problem hiding this comment.
Enriched schema would definitely be nice to have, especially for POST requests. I think we would have to pull a pinned version of the beacon-API schema from github and then override each route based on operationId. This will become especially important if we want to generate a API docs page with redoc (or similar tooling).
wemeetagain
commented
Sep 20, 2023
| opts: BeaconRestApiServerOpts, | ||
| version = "" | ||
| ): Promise<void> { | ||
| await server.register(await import("@fastify/swagger"), { |
There was a problem hiding this comment.
| tags: opts.api.map((namespace) => ({name: namespace})), | ||
| }, | ||
| }); | ||
| await server.register(await import("@fastify/swagger-ui"), { |
There was a problem hiding this comment.
Performance Report✔️ no performance regression detected Full benchmark results
|
nflaig
reviewed
Sep 20, 2023
| ): void { | ||
| server.route({ | ||
| url: route.url, | ||
| method: route.method, | ||
| handler: route.handler, | ||
| schema: route.schema, | ||
| // append the namespace as a tag for downstream consumption of our API schema, eg: for swagger UI | ||
| schema: {...route.schema, ...(namespace ? {tags: [namespace]} : undefined)}, |
There was a problem hiding this comment.
Enriched schema would definitely be nice to have, especially for POST requests. I think we would have to pull a pinned version of the beacon-API schema from github and then override each route based on operationId. This will become especially important if we want to generate a API docs page with redoc (or similar tooling).
| @@ -89,4 +91,12 @@ export const options: CliCommandOptions<ApiArgs> = { | |||
| type: "number", | |||
| description: "Defines the maximum payload, in bytes, the server is allowed to accept", | |||
| }, | |||
|
|
|||
| "rest.swaggerUI": { | |||
There was a problem hiding this comment.
should we also support this for the validator keymanager API?
For keymanager would also be nice to support bearer auth through the explorer but again might not be worth the effort.
| "Enable Swagger UI for API exploration at http://{address}:{port}/documentation. This should not be used in production.", | ||
| default: Boolean(defaultOptions.api.rest.swaggerUI), | ||
| group: "api", | ||
| }, |
There was a problem hiding this comment.
Potential other config options
- path
- server url (would be required if node runs behind proxy)
Depending on what use cases we see for this, might not be worth to add those now.
Co-authored-by: Nico Flaig <nflaig@protonmail.com>
nflaig
reviewed
Sep 22, 2023
| const url = await import("node:url"); | ||
| // eslint-disable-next-line @typescript-eslint/naming-convention | ||
| const __dirname = path.dirname(url.fileURLToPath(import.meta.url)); | ||
| return await fs.readFile(path.join(__dirname, "../../../../../assets/", name)); |
There was a problem hiding this comment.
Just noticed we don't copy assets in our docker build
Line 8 in 4fd3d4d
I think we can just include them, size impact is relatively low
1.2M assets
288.1M node_modules
nflaig
approved these changes
Sep 22, 2023
|
🎉 This PR is included in v1.12.0 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Description
--rest.swaggerUIcli option (default to false)/documentation