loopbackio / loopbackio/loopback-next

Application Config rest.openApiSpec disabled: true doesnt seem to work

オープン
#9,530 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

bug
主要言語
TypeScript
スター
5.1k
フォーク
1.1k
平均マージ
2日 21時間
マージ済み PR(30日)
27

説明

Describe the bug

Currently I set my config as this

const config = {
    rest: {
      port: +(process.env.PORT ?? 3000),
      host: process.env.HOST,
      // The `gracePeriodForClose` provides a graceful close for http/https
      // servers with keep-alive clients. The default value is `Infinity`
      // (don't force-close). If you want to immediately destroy all sockets
      // upon stop, set its value to `0`.
      // See https://www.npmjs.com/package/stoppable
      gracePeriodForClose: 5000, // 5 seconds
      openApiSpec: {
        // setServersFromRequest: process.env.NODE_ENV === 'development',
        disabled: true,
        // servers: [{url: 'https://mp.localhost/api'}],
      },
    },

endpoint to /api/explorer still accessible where it should not
https://loopback.io/doc/en/lb4/Customizing-how-openapi-spec-is-served.html

Logs

No response

Additional information

No response

Reproduction

https://codesandbox.io/s/nostalgic-taussig-qgxc52

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Issue に示されている REST アプリケーション設定から始め、文書化されている rest.openApiSpec.disabled の動作と /api/explorer エンドポイントを比較します。リンク先の CodeSandbox を使って問題を再現し、リンク先の OpenAPI の提供に関するドキュメントを確認します。設定を無効にすると、期待どおり /api/explorer にアクセスできなくなれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
openapi, typescript
領域
api
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。