説明
OpenAPIのinfo.contact.emailは、APIに関する問い合わせ先のメールアドレスです。表記やドメインの誤りは連絡を妨げますが、形式が正しいだけでメールボックスの存在や受信可能性が保証されるわけではありません。
想定される影響
API利用者や協力者がサポート担当者に連絡できなかったり、誤った相手に問い合わせを送ったりする場合があります。
対処方法
ローカル部とドメインを確認し、実際に管理している受信アドレスを指定してください。文書に表示されるアドレスと、運用上のサポート窓口が一致しているかも確認してください。
例
gmail.comを意図していたのにgmail.cと記載した状況を想定した例です。トップレベルドメインの文字数だけで、すべてのメールアドレスの有効性を判断しないでください。
変更前
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0",
"contact": {
"name": "contact",
"url": "https://www.google.com/",
"email": "user@gmail.c"
}
},
"paths": {
"/": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"examples": {
"foo": {
"value": {
"versions": [
{
"status": "CURRENT",
"updated": "2011-01-21T11:33:21Z",
"id": "v2.0",
"links": [
{
"href": "http://127.0.0.1:8774/v2/",
"rel": "self"
}
]
}
]
}
}
}
}
}
}
}
}
}
}
}
変更後
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0",
"contact": {
"name": "contact",
"url": "https://www.google.com/",
"email": "user@gmail.com"
}
},
"paths": {
"/": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"examples": {
"foo": {
"value": {
"versions": [
{
"status": "CURRENT",
"updated": "2011-01-21T11:33:21Z",
"id": "v2.0",
"links": [
{
"href": "http://127.0.0.1:8774/v2/",
"rel": "self"
}
]
}
]
}
}
}
}
}
}
}
}
}
}
}
ドメインの表記を修正しても、例のメールボックスが実際のサポート担当者のものだとは限りません。運用上の連絡先に置き換えてください。