# 編輯器支援 { #editor-support }

官方的 [FastAPI 擴充套件](https://marketplace.visualstudio.com/items?itemName=FastAPILabs.fastapi-vscode) 透過支援路徑操作（path operation）探索、導覽，以及 FastAPI Cloud 部署與即時日誌串流，強化你的 FastAPI 開發流程。

想了解更多關於此擴充套件的細節，請參考其 [GitHub 儲存庫](https://github.com/fastapi/fastapi-vscode) 中的 README。

## 安裝與設定 { #setup-and-installation }

/// info | 정보

"경로"는 일반적으로 "엔드포인트" 또는 "라우트"라고도 불립니다.

///

API를 설계할 때 "경로"는 "관심사"와 "리소스"를 분리하기 위한 주요한 방법입니다.

#### 작동 { #operation }

"작동(Operation)"은 HTTP "메소드" 중 하나를 나타냅니다.

다음 중 하나이며:

* `POST`
* `GET`
* `PUT`
* `DELETE`

...흔히 사용되지 않는 것들도 있습니다:

* `OPTIONS`
* `HEAD`
* `PATCH`
* `TRACE`

HTTP 프로토콜에서는 이러한 "메소드"를 하나(또는 이상) 사용하여 각 경로와 통신할 수 있습니다.

         * Checks if the crawling thread has finished execution.
         *
         * @return true if the thread has completed its crawling operation
         */
        public boolean isFinished() {
            return finished;
        }

        /**
         * Stops the crawling operation gracefully.
         * If a data store is currently active, this method calls
         * its stop method to halt the crawling process.

   * @deprecated Unsupported operation.
   */
  @Deprecated
  @Override
  @DoNotCall("Always throws UnsupportedOperationException")
  public void remove(Range<C> range) {
    throw new UnsupportedOperationException();
  }

  /**
   * Guaranteed to throw an exception and leave the {@code RangeSet} unmodified.
   *
   * @throws UnsupportedOperationException always
   * @deprecated Unsupported operation.
   */

     * Used for navigating through multiple pages of failure records.
     */
    @ValidateTypeFailure
    public String pageNumber;

    /**
     * The CRUD operation mode for this form.
     * Indicates whether this is a create, read, update, or delete operation.
     */
    @ValidateTypeFailure
    public Integer crudMode;

    /**
     * The unique identifier of the failure URL record being edited.

Because it's a Python exception, you don't `return` it, you `raise` it.

This also means that if you are inside a utility function that you are calling inside of your *path operation function*, and you raise the `HTTPException` from inside of that utility function, it won't run the rest of the code in the *path operation function*, it will terminate that request right away and send the HTTP error from the `HTTPException` to the client.

你不必為你使用到的每個標籤都加入中繼資料。

///

### 使用你的標籤 { #use-your-tags }

在你的路徑操作（以及 `APIRouter`s）上使用 `tags` 參數，將它們歸類到不同標籤下：

{* ../../docs_src/metadata/tutorial004_py310.py hl[21,26] *}

/// info | 資訊

在 [Path Operation Configuration](path-operation-configuration.md#tags) 中閱讀更多關於標籤的內容。

///

### 檢視文件 { #check-the-docs }

現在檢視文件時，會看到所有額外的中繼資料：

<img src="/img/tutorial/metadata/image02.png">

### 標籤順序 { #order-of-tags }

 * also defines an additional query operation, {@link #count}, which returns the count of an
 * element. There are five new bulk-modification operations, for example {@link #add(Object, int)},
 * to add or remove multiple occurrences of an element at once, or to set the count of an element to
 * a specific value. These modification operations are optional, but implementations which support

app = FastAPI()


@app.get("/items/")
async def read_items():
    return [{"item_id": "Foo"}]


def use_route_names_as_operation_ids(app: FastAPI) -> None:
    """
    Simplify operation IDs so that generated API clients have simpler function
    names.

    Should be called only after all routes have been added.
    """
    for route in app.routes:
        if isinstance(route, APIRoute):

///

### Path operation 関数 { #path-operation-functions }

*path operation 関数* を `async def` ではなく通常の `def` で宣言した場合、(サーバをブロックしてしまうため) 直接呼び出されるのではなく、外部のスレッドプールで実行され、それを待機します。