Skip to main content
이 가이드는 LangSmith API 문서의 OpenAPI 보안 스키마를 사용자 정의하는 방법을 보여줍니다. 잘 문서화된 보안 스키마는 API 사용자가 API 인증 방법을 이해하는 데 도움이 되며, 자동 클라이언트 생성도 가능하게 합니다. LangGraph의 인증 시스템에 대한 자세한 내용은 인증 및 접근 제어 개념 가이드를 참조하세요.
구현 vs 문서화 이 가이드는 OpenAPI에서 보안 요구사항을 문서화하는 방법만 다룹니다. 실제 인증 로직을 구현하려면 사용자 정의 인증 추가 방법을 참조하세요.
이 가이드는 모든 LangSmith 배포(클라우드 및 자체 호스팅)에 적용됩니다. LangSmith를 사용하지 않는 LangGraph 오픈소스 라이브러리 사용에는 적용되지 않습니다.

​
기본 스키마

기본 보안 스키마는 배포 유형에 따라 다릅니다:
  • LangSmith
기본적으로 LangSmith는 x-api-key 헤더에 LangSmith API 키를 요구합니다: 
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
security:
  - apiKeyAuth: []
LangGraph SDK 중 하나를 사용할 때 이는 환경 변수에서 추론될 수 있습니다.
  • Self-hosted
기본적으로 자체 호스팅 배포에는 보안 스키마가 없습니다. 이는 보안 네트워크에서만 배포하거나 인증과 함께 배포해야 함을 의미합니다. 사용자 정의 인증을 추가하려면 사용자 정의 인증 추가 방법을 참조하세요.

​
사용자 정의 보안 스키마

OpenAPI 문서에서 보안 스키마를 사용자 정의하려면 langgraph.json의 auth 구성에 openapi 필드를 추가하세요. 이는 API 문서만 업데이트한다는 점을 기억하세요 - 사용자 정의 인증 추가 방법에 표시된 대로 해당 인증 로직도 구현해야 합니다. LangSmith는 인증 엔드포인트를 제공하지 않으므로, 클라이언트 애플리케이션에서 사용자 인증을 처리하고 결과 자격 증명을 LangGraph API로 전달해야 합니다.
  • OAuth2 with Bearer Token
  • API Key
{
  "auth": {
    "path": "./auth.py:my_auth",  // Implement auth logic here
    "openapi": {
      "securitySchemes": {
        "OAuth2": {
          "type": "oauth2",
          "flows": {
            "implicit": {
              "authorizationUrl": "https://your-auth-server.com/oauth/authorize",
              "scopes": {
                "me": "Read information about the current user",
                "threads": "Access to create and manage threads"
              }
            }
          }
        }
      },
      "security": [
        {"OAuth2": ["me", "threads"]}
      ]
    }
  }
}

​
테스트

구성을 업데이트한 후:
  1. 애플리케이션을 배포합니다
  2. /docs를 방문하여 업데이트된 OpenAPI 문서를 확인합니다
  3. 인증 서버의 자격 증명을 사용하여 엔드포인트를 테스트합니다 (먼저 인증 로직을 구현했는지 확인하세요)
Edit the source of this page on GitHub.
Connect these docs programmatically to Claude, VSCode, and more via MCP for real-time answers.
⌘I