APIドキュメント技術文書

エンドポイントの説明からAPIドキュメントを作成

最短1日で納品修正対応込み品質チェック
プラン
安心決済詳しく
  • プランの範囲内の修正は無料です。
  • 納品から3日以内にご対応がない場合、自動的に承認されます。
注文する · ¥6,030

代金はお支払い時にお預かりし、納品を承認した時点ではじめて支払われます。

エンドポイントの説明からAPIドキュメントを作成

成果物の例

スタンダードパッケージの例

業務マニュアル(SOP):小さなカフェの開店・閉店手順

SOP-02:閉店作業

目的店を清潔で安全な状態にし、翌朝のシフトがすぐ始められるようにする
担当閉店担当のバリスタ。シフトリーダーが最終確認
時間17:30開始、18:00に施錠、18:45までに完了
用意するもの閉店チェックシート、レジの鍵、清掃用具かご、青いふきん

始める前に

注意: 壁の主電源は絶対に切らないでください。冷蔵庫と警報装置が同じ分電盤につながっています。

手順

  1. 17:30に入口の札を「ラストオーダー」に替える。 すでに店内にいるお客様は18:00までご利用いただけます。
  2. コーヒーマシンをすすぎモードにする。 カップボタンを5秒長押し。確認: 画面に「RINSE」が点滅し、両方のグループヘッドから約2分間お湯が流れる。
  3. ポルタフィルターを外し、 洗浄タブレット1錠を入れた黒い容器につける。そのまま20分置く。
  4. ケーキとサンドイッチを奥の冷蔵庫へ移す。 今日開封したものには、今日の日付と「明日まで」と書いたラベルを貼る。
  5. 冷蔵庫の温度を記録表に記入する。 確認: 1 °C〜5 °Cの範囲内。5 °Cを超えている冷蔵庫があれば、先に手順12へ。
  6. 18:00に入口を施錠し、 札を「閉店」に替える。
  7. レジを締める。 MENU →「日計」→「精算(Zレポート)」の順に押す。確認: 今日の売上合計が印字される。現金はカウンターで数えず、ドロワーごと事務所へ運ぶ。

(手順8〜14:床、ごみ、警報装置、引き継ぎメモ)

うまくいかないとき

問題対応
冷蔵庫が5 °Cを超えている食品をもう1台の冷蔵庫へ移し、時刻と温度を記録して、シフトリーダーに連絡
Zレポートが印字されないロール紙を交換。それでも出ない場合は、画面の合計を書き写して写真を撮る
警報装置がセットできない裏口が完全に閉まっているか確認。開いたままではセットできない

確認欄

閉店担当バリスタ:氏名、時刻。シフトリーダー:イニシャル。

最終見直し日: [日付]。コーヒーマシンかレジを入れ替えたときに再度見直すこと。

クライアント: カフェ すずらん(22席、スタッフ7名がシフト制で勤務) 資料: オーナーの音声メモ、手書きのチェックリスト、カウンター・コーヒーマシン・レジ画面の写真9枚 納品物: SOP 6本(約1万4,000字):開店、閉店、現金の取り扱い、冷蔵庫の温度記録、コーヒーマシンの徹底洗浄、お客様からの苦情対応。以下は閉店手順の抜粋です。

お客様とすべての情報は架空のものです。

このサービスについて

開発者はドキュメントを見て数分でAPIを判断します。認証や最初のリクエストがうまくいかなければ離れていきます。お客様のエンドポイントの説明、OpenAPIファイル、コードサンプルから、APIリファレンスとガイドを作成します。認証、ベースURL、パラメータ付きの各エンドポイント、リクエストとレスポンスの例、エラーコード、レート制限、ページネーションまで。クイックスタートでは、数ステップで最初の呼び出しを成功させる方法を示します。

含まれる内容

  • 納品内容コードブロック付きのMarkdown形式のAPIドキュメントで、ReadMe、GitBook、Docusaurus、リポジトリにそのまま使えます。お送りいただいた内容をもとに作成し、APIを実際に呼び出すことはありません。
  • クイックスタートAPIキーから最初の呼び出しまで
  • エンドポイントのリファレンスパラメータ、型、例
  • エラーと制限コード、意味、再試行のアドバイス
  • コードサンプルcURLとお好みの言語1つ
  • 用語の統一スキーマと同じ名前

ご利用の流れ

  1. 1
    依頼内容お客様がエンドポイントと例を貼り付けるか添付します
  2. 2
    構成と執筆リファレンスとガイドを作成します
  3. 3
    納品すぐに公開できるMarkdownをお受け取りいただけます

ご用意いただくもの

テキストで貼り付けたエンドポイントの説明またはOpenAPI・Postmanのファイル、認証の詳細、リクエストとレスポンスの例、エラーコード、APIの利用者をお知らせください。

お伺いする内容:

  • APIの機能と、利用者を教えてください。
  • 認証はどのような仕組みですか?
  • cURL以外に、コードサンプルではどの言語を使いますか?
  • ドキュメントはどこで公開しますか?

プランを比較

プランベーシッククイックスタートと最大5つのエンドポイント¥2,940スタンダードガイド付きで最大20のエンドポイント¥6,030プレミアム最大50のエンドポイント、ドキュメント一式¥12,210
納期1日3日5日
修正回数123
分量最大2,000語最大6,000語最大14,000語
エンドポイント数最大5最大20最大50
コードサンプルの言語cURLcURL+1cURL+2
注文する ベーシック注文する スタンダード注文する プレミアム

安心決済

お支払いは注文時ですが、代金が支払われるのは承認された納品に対してのみです。

  • 固定料金お支払い後にプランの料金が変わることはありません。
  • 代金はお預かりお支払い時、代金はお預かりするだけです。納品を承認した時点でサービス側に支払われます。
  • 納品前にチェックすべての成果物はお手元に届く前に品質チェックを受けます。承認前に注文ページで内容を確認できます。
  • 無料の修正依頼内容の範囲内で、プランで定められた回数まで修正を依頼できます。
  • 3日後に自動承認納品から3日以内に承認も修正依頼もない場合、自動的に承認されます。納品後に注文チャットでメッセージを送った場合、注文は保留されます。こちらから回答した後、3日間のカウントを再開することがあり、その際はチャットでお知らせします。
  • やり直しまたは全額返金結果が依頼内容と合わず修正でも解決しなかった場合、または作業に納期の2倍を超える時間がかかった場合は、注文チャットでご連絡ください。作業をやり直すか、代金を全額返金いたします。
詳しい仕組み →

質問と回答

OpenAPIの仕様書をもとに作成してもらえますか?

はい、YAMLまたはJSONを依頼内容に貼り付けてください。その説明を読みやすいリファレンスページにし、ご指摘いただいた不足部分を補います。

例はテストしてもらえますか?

APIは呼び出しません。例はいただいたリクエストとレスポンスのサンプルから作成するので、公開前に一度実行してください。

SDKのドキュメントも書いてもらえますか?

はい、メソッドのシグネチャと使用例をお送りいただければ対応します。各SDKはプランの分量の一部として数えます。

プラン
注文する · ¥6,030· 3日