Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 11 - 17 of 17 for externalDocs (0.07 seconds)

  1. docs/ko/docs/tutorial/metadata.md

    리스트는 각 태그에 대해 하나의 딕셔너리를 포함해야 합니다.
    
    각 딕셔너리에는 다음이 포함될 수 있습니다:
    
    * `name` (**필수**): `tags` 매개변수에서 *경로 작동*과 `APIRouter`에 사용된 태그 이름과 동일한 `str`입니다.
    * `description`: 태그에 대한 간단한 설명을 담은 `str`입니다. 마크다운을 사용할 수 있으며 문서 UI에 표시됩니다.
    * `externalDocs`: 외부 문서를 설명하는 `dict`이며:
        * `description`: 외부 문서에 대한 간단한 설명을 담은 `str`입니다.
        * `url` (**필수**): 외부 문서의 URL을 담은 `str`입니다.
    
    ### 태그에 대한 메타데이터 생성
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Mon Nov 18 02:25:44 GMT 2024
    - 6.4K bytes
    - Click Count (0)
  2. fastapi/openapi/utils.py

            output["components"] = components
        output["paths"] = paths
        if webhook_paths:
            output["webhooks"] = webhook_paths
        if tags:
            output["tags"] = tags
        if external_docs:
            output["externalDocs"] = external_docs
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 23.2K bytes
    - Click Count (0)
  3. src/main/config/openapi/openapi-user.yaml

    info:
      title: Fess - User API
      description: |-
        This is a Fess Server based on the OpenAPI 3.0 specification.  
      license:
        name: Apache 2.0
        url: http://www.apache.org/licenses/LICENSE-2.0.html
      version: 14.8.0
    externalDocs:
      description: API Documentation
      url: https://fess.codelibs.org/14.8/api/
    servers:
      - url: http://localhost:8080/api/v1
    tags:
      - name: search
        description: Search operations
      - name: popularword
    Created: Sat Dec 20 09:19:18 GMT 2025
    - Last Modified: Thu May 09 06:31:27 GMT 2024
    - 21.6K bytes
    - Click Count (0)
  4. tests/test_application.py

        response = client.get("/openapi.json")
        assert response.status_code == 200, response.text
        assert response.json() == {
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "externalDocs": {
                "description": "External API documentation.",
                "url": "https://docs.example.com/api-general",
            },
            "paths": {
                "/api_route": {
                    "get": {
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 18:19:10 GMT 2025
    - 51.9K bytes
    - Click Count (0)
  5. fastapi/applications.py

                    ```python
                    from fastapi import FastAPI
    
                    external_docs = {
                        "description": "Detailed API Reference",
                        "url": "https://example.com/api-docs",
                    }
    
                    app = FastAPI(openapi_external_docs=external_docs)
                    ```
                    """
                ),
            ] = None,
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 21:25:59 GMT 2025
    - 176.3K bytes
    - Click Count (0)
  6. tests/main.py

    import http
    from typing import Optional
    
    from fastapi import FastAPI, Path, Query
    
    external_docs = {
        "description": "External API documentation.",
        "url": "https://docs.example.com/api-general",
    }
    
    app = FastAPI(openapi_external_docs=external_docs)
    
    
    @app.api_route("/api_route")
    def non_operation():
        return {"message": "Hello World"}
    
    
    def non_decorated_route():
        return {"message": "Hello World"}
    
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 21:25:59 GMT 2025
    - 4.5K bytes
    - Click Count (0)
  7. docs/en/docs/release-notes.md

    * ✨ Allow array values for OpenAPI schema `type` field. PR [#13639](https://github.com/fastapi/fastapi/pull/13639) by [@sammasak](https://github.com/sammasak).
    * ✨ Add OpenAPI `external_docs` parameter to `FastAPI`. PR [#13713](https://github.com/fastapi/fastapi/pull/13713) by [@cmtoro](https://github.com/cmtoro).
    
    ### Fixes
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 19:06:15 GMT 2025
    - 586.7K bytes
    - Click Count (0)
Back to Top