pythonで連想語APIを叩きたい

Question

前提・実現したいこと

pythonで下のAPIを叩きたい。
https://metadata.co.jp/apis/word-associator-specifications.html

エラーメッセージ

Traceback (most recent call last):
  File "keyword.py", line 27, in <module>
    print(keywords('東京'))
  File "keyword.py", line 19, in keywords
    url = api.format(data)
KeyError: 'api_query'

該当のソースコード

#python  3.7.1
import json
import requests

api = "http://wordassociator.ap.mextractr.net/word_associator/{api_query}?query={word}"
user_name = "登録時の名前"
password = "登録時のパスワード"

def keywords(word: str):
    data = {
        'api_query': 'Japanese',
        'word': word,
    }

    payload = {
        'password': 'user_name'
    }

    url = api.format(data)

    r = requests.get(url,params=payload)

    body = json.loads(r.text)

    return body

print(keywords('東京'))

問題点

・エラーの解決方法が分からない

試したこと

WebAPIはほとんど触ったことがなかったため、以下のサイトを参考にしました。
・https://appcoding.net/python-requests-basic/
・https://qiita.com/syunyo/items/b408b8d61f9f73b21da7

補足情報

使用したIDE:Visual Studio Code
OS:Windows10

Answer 1

エラーメッセージを見るとurl = api.format(data)の部分でエラーが発生していることがわかります。

formatを使う時、フォーマットも文字列の波括弧の中に変数名を指定している場合、どの変数がその値に対応しているか指定してやらなければなりません。

>>> url = 'http://example.com/?query={word}'
>>> word = 'test'
# よくない例
>>> print(url.format(word))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'word'
# 正しい例
>>> print(url.format(word=word))
'http://example.com/?query=test'

つまり、ソースコードを以下のように変更すれば動くと思います。

# 変更前
url = api.format(data)
# 変更後
url = api.format(api_query=data["api_query"], word=data["word"])

あと、認証する方法が違うのでそこも修正する必要があります。認証を行うときはrequests.getを呼び出す時にauth=('username', 'password')という引数を与えます。よって、ソースコードを

# 変更前
payload = {
    'password': 'username'
}

r = requests.get(api, params=payload)

# 変更後
payload = ('username', 'password')
r = requests.get(api, auth=payload)

※usernameとpasswordは自分の登録したユーザー名とパスワードに置き換えてください

と変更してやる必要があります。

---

参考リンク

• Requests - Authentication

Comments

[退会済みユーザー]

ご丁寧に解説していただき誠にありがとうございます。回答の方法を試した結果エラーメッセージはなくなったのですが、今度はjsonファイルが読み込めないと出てきました。例外処理を使って回避しようとすると、エラーはでないもののNoneと返されてしまい、困っています。もし解決策をご存じでしたら、教えていただけると幸いです。例外処理は以下のように書きました。
try:
body = json.loads(r.text)
return body
except Exception:
pass

[miso24]

同じコードを実行してprint(r)を実行してみると<Response[404]>となっていたので、URLが間違っているようです。
ですので、以下の２つの箇所を修正すればうまく動作すると思われます。
# 変更前
- api = "http://wordassociator.ap.mextractr.net/word_associator/{api_query}?query={word}"
- url = api.format(api_query=data["api_query"], word=data["word"])
# 変更後
- api = "http://wordassociator.ap.mextractr.net/word_associator/api_query?query={word}"
- url = api.format(word=data["word"])
api_queryの部分はjapaneseにする必要はありません。

[退会済みユーザー]

出力できました！ありがとうございます！