feat: add swagger ui API explorer #5970
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import {FastifyInstance} from "fastify"; | ||
| import {BeaconRestApiServerOpts} from "./index.js"; | ||
|
|
||
| export async function registerSwaggerUIRoutes( | ||
| server: FastifyInstance, | ||
| opts: BeaconRestApiServerOpts, | ||
| version = "" | ||
| ): Promise<void> { | ||
| await server.register(await import("@fastify/swagger"), { | ||
| openapi: { | ||
| info: { | ||
| title: "Lodestar API", | ||
| description: "API specification for the Lodestar beacon node", | ||
| version, | ||
| contact: { | ||
| name: "Lodestar Github", | ||
| url: "https://github.com/chainsafe/lodestar", | ||
| }, | ||
| }, | ||
| externalDocs: { | ||
| url: "https://chainsafe.github.io/lodestar", | ||
| description: "Lodestar documentation", | ||
| }, | ||
| tags: opts.api.map((namespace) => ({name: namespace})), | ||
| }, | ||
| }); | ||
| await server.register(await import("@fastify/swagger-ui"), { | ||
|
There was a problem hiding this comment. |
||
| theme: { | ||
| title: "Lodestar API", | ||
| favicon: await getFavicon(), | ||
| }, | ||
| logo: await getLogo(), | ||
| }); | ||
wemeetagain marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| /** | ||
| * Fallback-friendly function to get an asset | ||
| */ | ||
| async function getAsset(name: string): Promise<Buffer | undefined> { | ||
| try { | ||
| const path = await import("node:path"); | ||
| const fs = await import("node:fs/promises"); | ||
| 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 Line 8 in 4fd3d4d I think we can just include them, size impact is relatively low |
||
| } catch (e) { | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/explicit-function-return-type | ||
| export async function getFavicon() { | ||
| const content = await getAsset("round-icon.ico"); | ||
| if (!content) { | ||
| return undefined; | ||
| } | ||
|
|
||
| return [ | ||
| { | ||
| filename: "round-icon.ico", | ||
| rel: "icon", | ||
| sizes: "16x16", | ||
| type: "image/x-icon", | ||
| content, | ||
| }, | ||
| ]; | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/explicit-function-return-type | ||
| export async function getLogo() { | ||
| const content = await getAsset("lodestar_icon_text_white.png"); | ||
| if (!content) { | ||
| return undefined; | ||
| } | ||
|
|
||
| return { | ||
| type: "image/png", | ||
| content, | ||
| }; | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import {expect} from "chai"; | ||
| import {getFavicon, getLogo} from "../../../../src/api/rest/swaggerUI.js"; | ||
|
|
||
| describe("swaggerUI", () => { | ||
| it("should find the favicon and logo", async () => { | ||
| expect(await getFavicon()).to.not.be.undefined; | ||
| expect(await getLogo()).to.not.be.undefined; | ||
| }); | ||
| }); |
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/fastify/fastify-swagger