sheet-schema

Google Sheets -> OpenAPI (OAS) generator.

Install

npm install
npm run build

Usage

SPREADSHEET_ID=your_sheet_id \
node dist/src/cli.js gen-oas

Or install the bin locally:

npm link
sheet-schema gen-oas --spreadsheet-id your_sheet_id

Create a typed header row:

sheet-schema init-sheet --sheet users \\
  --column "id*:uuid" \\
  --column "email*:email" \\
  --column "name:string"

Env

• SPREADSHEET_ID: target spreadsheet id
• GOOGLE_APPLICATION_CREDENTIALS: service account json path (recommended)

Options

• --path-prefix defaults to /api
• --exclude-prefixes defaults to _,#
• --scan-rows defaults to 10

DeveloperMetadata format

Put JSON in metadataValue, for example:

{
  "ref": { "table": "users", "field": "id", "expandKey": "user" },
  "description": "Owner"
}

If you want to restrict metadata usage to a specific key, set --metadata-key and use the same metadataKey in Sheets.

Rules

• 1 sheet = 1 table
• First row is header
• id* is required (UUID string)
• Header ending with * is NOT NULL (required in OAS)
• Type priority: DeveloperMetadata > data validation enum > checkbox > format > string

Outputs

• openapi.json
• schema.json
• openapi.hash

Docs (Korean)

• docs/guide.ko.md