[API] patch swagger host to be relative #563
Merged
Conversation
This file contains hidden or 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
server/swagger/init.jsIt's a good practice to separate the logic into smaller, more manageable functions. This makes the code easier to read and maintain. In this case, the logic of writing to the file can be extracted into a separate function. function writeToFile(outputFile, data) {
fs.writeFileSync(outputFile, JSON.stringify(data, null, 2), { encoding: 'utf-8', flag: 'w' });
console.log(`Swagger-autogen: \x1b[32mPatched servers.url β\x1b[0m`);
}Using synchronous file operations can block the event loop and negatively impact the performance of your application. It's recommended to use asynchronous file operations whenever possible. fs.writeFile(outputFile, JSON.stringify(openApiSpec, null, 2), { encoding: 'utf-8', flag: 'w' }, (err) => {
if (err) throw err;
console.log(`Swagger-autogen: \x1b[32mPatched servers.url β\x1b[0m`);
}); |
Comment on lines
+41
to
+51
| swaggerAutogen(outputFile, endpointsFiles, doc) | ||
| .then(({ data }) => { | ||
| const openApiSpec = { | ||
| ...data, | ||
| servers: [{ | ||
| url: "/api" | ||
| }] | ||
| } | ||
| fs.writeFileSync(outputFile, JSON.stringify(openApiSpec, null, 2), { encoding: 'utf-8', flag: 'w' }); | ||
| console.log(`Swagger-autogen: \x1b[32mPatched servers.url β\x1b[0m`) | ||
| }) |
There was a problem hiding this comment.
Extracted the logic of writing to the file into a separate function to improve the readability and maintainability of the code.
Suggested change
| swaggerAutogen(outputFile, endpointsFiles, doc) | |
| .then(({ data }) => { | |
| const openApiSpec = { | |
| ...data, | |
| servers: [{ | |
| url: "/api" | |
| }] | |
| } | |
| fs.writeFileSync(outputFile, JSON.stringify(openApiSpec, null, 2), { encoding: 'utf-8', flag: 'w' }); | |
| console.log(`Swagger-autogen: \x1b[32mPatched servers.url β\x1b[0m`) | |
| }) | |
| function writeToFile(outputFile, data) { | |
| fs.writeFileSync(outputFile, JSON.stringify(data, null, 2), { encoding: 'utf-8', flag: 'w' }); | |
| console.log(`Swagger-autogen: \x1b[32mPatched servers.url β\x1b[0m`); | |
| } | |
| swaggerAutogen(outputFile, endpointsFiles, doc) | |
| .then(({ data }) => { | |
| const openApiSpec = { | |
| ...data, | |
| servers: [{ | |
| url: "/api" | |
| }] | |
| } | |
| writeToFile(outputFile, openApiSpec); | |
| }) |
Comment on lines
+49
to
+50
| fs.writeFileSync(outputFile, JSON.stringify(openApiSpec, null, 2), { encoding: 'utf-8', flag: 'w' }); | ||
| console.log(`Swagger-autogen: \x1b[32mPatched servers.url β\x1b[0m`) |
There was a problem hiding this comment.
The synchronous file writing operation has been replaced with an asynchronous one to improve the performance of the application.
Suggested change
| fs.writeFileSync(outputFile, JSON.stringify(openApiSpec, null, 2), { encoding: 'utf-8', flag: 'w' }); | |
| console.log(`Swagger-autogen: \x1b[32mPatched servers.url β\x1b[0m`) | |
| fs.writeFile(outputFile, JSON.stringify(openApiSpec, null, 2), { encoding: 'utf-8', flag: 'w' }, (err) => { | |
| if (err) throw err; | |
| console.log(`Swagger-autogen: \x1b[32mPatched servers.url β\x1b[0m`); | |
| }); |
cabwds
pushed a commit
to cabwds/anything-llm
that referenced
this pull request
Jul 3, 2025
patch swagger host to be relative
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.
Pull Request Type
Relevant Issues
resolves #561
What is in this change?
Update API to use relative hostname
Developer Validations
yarn lintfrom the root of the repo & committed changes