-
-
Notifications
You must be signed in to change notification settings - Fork 287
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
214 additions
and
9 deletions.
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"), { | ||
| theme: { | ||
| title: "Lodestar API", | ||
| favicon: await getFavicon(), | ||
| }, | ||
| logo: await getLogo(), | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * 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)); | ||
| } 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