OpenAPI Spec — public REST 진입점

endpoint 카탈로그

경로	method	매핑
/v1/company/{@html String.fromCharCode(123)}code{@html String.fromCharCode(125)}/show/{@html String.fromCharCode(123)}topic{@html String.fromCharCode(125)}	GET	Company.show
/v1/company/{@html String.fromCharCode(123)}code{@html String.fromCharCode(125)}/analysis/{@html String.fromCharCode(123)}axis{@html String.fromCharCode(125)}	GET	Company.analysis
/v1/scan/{@html String.fromCharCode(123)}axis{@html String.fromCharCode(125)}	GET	scan
/v1/macro/{@html String.fromCharCode(123)}axis{@html String.fromCharCode(125)}	GET	dartlab.macro
/v1/quant/{@html String.fromCharCode(123)}axis{@html String.fromCharCode(125)}	GET	dartlab.quant
/v1/search	GET	dartlab.search
/v1/recipe/{@html String.fromCharCode(123)}id{@html String.fromCharCode(125)}/execute	POST	recipe execute
/v1/skills	GET	listSkills
/v1/skill/{@html String.fromCharCode(123)}id{@html String.fromCharCode(125)}	GET	getSkill

OpenAPI 3.0 YAML (snippet)

openapi: 3.0.0
info:
  title: dartlab API
  version: 0.10.3
paths:
  /v1/company/{code}/show/{topic}:
    get:
      parameters:
        - name: code
          in: path
          required: true
          schema: {type: string, pattern: "^[0-9]{6}$"}
        - name: topic
          in: path
          required: true
          schema: {type: string, enum: [BS, IS, CF, CIS, SCE]}
      responses:
        200:
          description: success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CompanyShowResult"

강행 룰

1. 모든 endpoint OpenAPI YAML 작성 (자동 생성 X — 사람 작성).
2. error code 표준 (400/401/404/429/500).
3. rate limit (per-API-key, per-IP).
4. response 단위 dateRef + evidence ref 동행.

기본 검증

• YAML 정합 (swagger-cli validate).
• 모든 endpoint test 통과 (smoke).
• rate limit metric.