MyService API

MyService の基本仕様(認証・バージョン・エラー形式など)

Base URL

type
APIOverview
status
stable
title
MyService API
description
MyService の基本仕様(認証・バージョン・エラー形式など)
resource
https://example.com/api
tags
api; myservice
generated
at: 2026-08-11T00:00:00Z, by: human:okf-seedling
verified
at: 2026-08-11T00:00:00Z, by: human:okf-seedling
stale_after
2026-12-31
sources
id: swagger, resource: https://example.com/openapi.json, title: OpenAPI 定義

https://example.com

Versioning

v1。破壊的変更はメジャーアップグレードで行う。

Authentication

  • リクエストヘッダ Authorization: Bearer <token> で認証する。
  • トークン発行は POST /v1/auth/token を参照。

Common Errors

Status Meaning
400 Bad Request(バリデーションエラー)
401 Unauthorized(トークン欠落・失効)
404 Not Found(リソース不存在)
429 Too Many Requests(レート制限)
500 Internal Server Error

共通スキーマは API Overview の各エンドポイント と共有する。1

Footnotes

  1. OpenAPI 定義↩︎