如何从 Loopback 应用程序中删除所有前端文件
How to remove all frontend files from Loopback app
在环回 api 上开发时,默认的 lp4 app
命令生成一个简单的带有 swagger api 浏览器的登录页面非常方便。
但是当我完成时我不想要这个。我应该在代码的哪个位置禁用自托管页面,我应该删除哪些文件以删除项目中不相关的文件?
有 4 个工件您可能想要单独 disabled/removed:
- 默认
/
着陆页: 链接到 openapi.json
和 API 浏览器的默认页面。
- Externally-hosted REST 资源管理器重定向: 从
/swagger-ui
和 /explorer
重定向到托管在别处的 REST 资源管理器(例如 https://explorer.loopback.io).
- Self-hosted REST 浏览器: 在
/explorer
服务的 REST 浏览器。默认情况下,优先于 /explorer
路径的托管 REST 资源管理器重定向。
- OpenAPI 规范端点: OpenAPI 3.0 规范默认托管在
/openapi.json
。
尽管大多数 LoopBack 4 项目都可以完全遵循此处的说明,但更多自定义项目可能会移动某些内容(例如应用程序或组件配置)。
要删除默认的 /
着陆页:
删除public
目录
从 src/application.ts
中删除以下行:
// Set up default home page
this.static('/', path.join(__dirname, '../public'));
要通过配置禁用 externally-hosted REST 资源管理器:
在src/index.ts
中配置config.rest.apiExplorer.disabled
:
const config = {
rest: {
apiExplorer: {
disabled: true,
},
},
};
要完全删除 self-hosted REST 资源管理器:
从 application.ts
中删除以下行:
// Customize @loopback/rest-explorer configuration here
this.configure(RestExplorerBindings.COMPONENT).to({
path: '/explorer',
});
this.component(RestExplorerComponent);
卸载@loopback/rest-explorer
通过配置禁用 OpenAPI 规范端点:
在src/index.ts
中配置config.rest.openApiSpec.disabled
:
const config = {
rest: {
openApiSpec: {
disabled: true,
},
},
};
请注意,禁用 OpenAPI 规范端点会阻止 REST 浏览器正常工作,因为它们依赖于网络 browser-accessible OpenAPI 规范。
禁用 OpanAPI 规范端点不会禁用从 TypeScript 中访问 OpenAPI 规范,也不会影响 AJV 验证。
参考资料
- https://loopback.io/doc/en/lb4/Customizing-server-configuration.html#disable-redirect-to-api-explorer
- https://loopback.io/doc/en/lb4/Customizing-server-configuration.html#rest-options
- https://loopback.io/doc/en/lb4/Self-hosted-rest-api-explorer.html#disable-self-hosted-api-explorer
- https://loopback.io/doc/en/lb4/apidocs.rest.openapispecoptions.html
在环回 api 上开发时,默认的 lp4 app
命令生成一个简单的带有 swagger api 浏览器的登录页面非常方便。
但是当我完成时我不想要这个。我应该在代码的哪个位置禁用自托管页面,我应该删除哪些文件以删除项目中不相关的文件?
有 4 个工件您可能想要单独 disabled/removed:
- 默认
/
着陆页: 链接到openapi.json
和 API 浏览器的默认页面。 - Externally-hosted REST 资源管理器重定向: 从
/swagger-ui
和/explorer
重定向到托管在别处的 REST 资源管理器(例如 https://explorer.loopback.io). - Self-hosted REST 浏览器: 在
/explorer
服务的 REST 浏览器。默认情况下,优先于/explorer
路径的托管 REST 资源管理器重定向。 - OpenAPI 规范端点: OpenAPI 3.0 规范默认托管在
/openapi.json
。
尽管大多数 LoopBack 4 项目都可以完全遵循此处的说明,但更多自定义项目可能会移动某些内容(例如应用程序或组件配置)。
要删除默认的 /
着陆页:
删除
public
目录从
src/application.ts
中删除以下行:// Set up default home page this.static('/', path.join(__dirname, '../public'));
要通过配置禁用 externally-hosted REST 资源管理器:
在
src/index.ts
中配置config.rest.apiExplorer.disabled
:const config = { rest: { apiExplorer: { disabled: true, }, }, };
要完全删除 self-hosted REST 资源管理器:
从
application.ts
中删除以下行:// Customize @loopback/rest-explorer configuration here this.configure(RestExplorerBindings.COMPONENT).to({ path: '/explorer', }); this.component(RestExplorerComponent);
卸载
@loopback/rest-explorer
通过配置禁用 OpenAPI 规范端点:
在
src/index.ts
中配置config.rest.openApiSpec.disabled
:const config = { rest: { openApiSpec: { disabled: true, }, }, };
请注意,禁用 OpenAPI 规范端点会阻止 REST 浏览器正常工作,因为它们依赖于网络 browser-accessible OpenAPI 规范。
禁用 OpanAPI 规范端点不会禁用从 TypeScript 中访问 OpenAPI 规范,也不会影响 AJV 验证。
参考资料
- https://loopback.io/doc/en/lb4/Customizing-server-configuration.html#disable-redirect-to-api-explorer
- https://loopback.io/doc/en/lb4/Customizing-server-configuration.html#rest-options
- https://loopback.io/doc/en/lb4/Self-hosted-rest-api-explorer.html#disable-self-hosted-api-explorer
- https://loopback.io/doc/en/lb4/apidocs.rest.openapispecoptions.html