内部APIの確認方法

Question

###前提・実現したいこと
外注したアプリの開発方法に悩んでいます。
APIをLaravelで構築され、iOSクライアントをSwiftで構築されています。
APIは外部に公開していないため、内部でのみ通信出来る仕様と聞いているのですが、内部APIでリクエストを確認する方法がわかリマセン。

APIの学習を最近始め、Postmanなどで外部に公開されているAPIの挙動を見ているのですが、Postmanなどでは内部APIのリクエストを参照することは出来ないのでしょうか？

また内部APIのデバッグでオススメの方法がありましたら教えていただきたいです

Comments

[mtdsnsk]

この場合のAPIはWebAPIという認識で良いでしょうか？ 内部でのみ通信できる、というのをどのように実現しているか分からないのですが、アクセス制限を解除してもらえば良いと思うのですが。もしくはローカルにLaravelの動作環境を構築してログを見るとか。公開してなくてもインターネット経由であればどこかしらの経路を通ってアプリとサーバーがコミニュケーションを取るので・・・あ、同じネットワーク内でしか動作しないAPIということですか？VPNでしかアクセスできないアプリならVPN接続すれば普通にAPIを叩けるとおもいます

[mtdsnsk]

憶測でしかかけないため、開発した方に聞くのが一番だとおもいます

[kenny_sayama]

おっしゃる通りだと思いますm(_ _)m

Answer 1

この場合内部／外部に違いはありませんよ。
単に特定のアプリからの利用しか想定してないだけの普通のAPI。
利用を制限するために何かしてるならAPI開発側に聞くしかありません。

開発用にローカルAPIサーバーやステージング環境を用意したり
ドキュメントを整備するのはAPI開発側の仕事。
仕様が分からないというのは何か開発体制がおかしい。
まぁ初心者しかいない状態なんだろう…。
元々の依頼者が初心者すぎるとまともな判断ができず崩壊する。

Comments

[kenny_sayama]

非エンジニアが外注したため仕様が全くわからない状態となっています。
開発側に問い合わせて見ます
回答いただきありがとうございます

Answer 2

完全に推測になってしまうのですが、おそらく質問者様がおっしゃられている「内部API」というのは「認証機能付きの外部(Web)API」のことではないでしょうか？
WebAPIは通常APIトークンなどパスワードに代わるものをHTTPリクエストヘッダなどに追加して認証します。
もしそうであれば、Postmanにヘッダを追加する機能があると思いますので、Postmanで動作確認ができると思います。

Comments

[kenny_sayama]

回答頂きありがとうございます！
そちらのキーワードで調べて見ます！

Answer 3

内部と通信できるマシンにsshで接続できるならtunnelを掘りましょう。