APIデザイン中心の開発プラットフォーム「Apidog」を試してみた - Qiita
API設計、モック、テスト、ドキュメント作成を1つのプラットフォームで はじめに APIを開発する際に自分の知っている限りではこのような開発の流れとなっています。 要件を基にAPIのリクエストやレスポンスのインターフェースを設計する 設計した内容をドキュメントに残す モックを用意して、フロントエンド側の開発者が簡単な連携テストをすぐに出来るようにする APIを実装する 内部処理のテストを行う（DBに対する操作など） 実装したAPIがリクエストに対し想定通りのレスポンスを返すかAPIそのものに対するテストを行う そして、これらのフェーズで用いられるツールは異なっていることもあります。 設計、ドキュメント作成：Swagger UI、ReDoc等 あるいはExcelや社内Wiki モック：Swagger UI、Mock Service Worker等のライブラリ テスト：Swaggerの定義を基
【最新速報】ChatGPT APIの「概要と使い方」（Pythonコード付き）
お知らせ 📢 本記事の内容は、下記のZenn本に統合されたため、恐れ入りますが、下記をご参照ください m(_ _)m 最後に 最後まで読んでくださり、ありがとうございました！ この記事を通して、少しでもあなたの学びに役立てば幸いです！ おまけ①：生成AIエンジニア塾 より専門的な「生成AIエンジニア人材」を目指しませんか？ そんな方々に向けて、「生成AIエンジニア塾」というプログラムを始めました🎉 最終的なゴールとして、『エンタープライズ向けの生成AIシステムを構築するためのスキルを習得し、大手案件で活躍できる人材』を目標とします。 また、一人一人にしっかりと向き合って、メンタリングをできるようにするため、現在メンバーの人数制限をしております。本気度やスキルレベルの高い人から、順番にご案内しております。 ▼ 登録はこちらから ▼ おまけ②：AI Newsletter for Biz 最
ケンオール 📮 郵便番号住所検索・住所逆引き・法人情報API
ソフトウェアを常に最新に私たちはソフトウェアを最新に保つことがいかに難しいかを知っています。 ケンオールはデータを最新に保ち整理するプロセスを自動化し、変更を自動的に取り込むことができます。 さまざまなデータに対するAPIを使用して、既存のシステムを当社のシステムにリンクします。
GitHub - openai/openai-cookbook: Examples and guides for using the OpenAI API
✨ Navigate at cookbook.openai.com Example code and guides for accomplishing common tasks with the OpenAI API. To run these examples, you'll need an OpenAI account and associated API key (create a free account here). Set an environment variable called OPENAI_API_KEY with your API key. Alternatively, in most IDEs such as Visual Studio Code, you can create an .env file at the root of your repo contai
REST: ログアウトAPIのメソッドはPOST？ - Qiita
REST APIの設計について、ログアウトAPIのHTTPメソッドについて社内で議論があったので、メモしておきます。 ログアウトといっても連携サービス(OpenID Connectなど)からのログアウトなど、サーバサイドでのユーザ属性の変化など、データ変更を伴うものではなく、単なるセッション切り替えの話です。 結論: 方針 方針としては以下のように決めていくのがいいかと思います。 APIが存在しないべき: RESTfulならそもそもセッションのステートはサーバが持っていないはずなので、ログアウトAPI自体が存在しないべき. サーバサイドでDB変更などの処理を行っていないため、クライアントでtoken/sessionの破棄を行えば事足りるはず。 DELETE: TokenのrevokeならDELETEだろう. 名前やエンドポイントがlogoutとかでも意味的にはtoken revokeならD
【Rails】APIテストの書き方 - Qiita
概要 Railsで作成されたAPIのテストについてこちらを参考に必要最低限の情報をまとめました。 実際にこちらの記事で作成したAPIに対してテストを書いていきます。 何をテストする？ 適切なAPIはHTTPのレスポンスのステータスコードと実際のデータを含んだレスポンスボディを返します。 よって主にその２つをテストしていきます。 ステータスコード 通常APIによって返されるステータスコードは以下の４つに分類されます。 APIの動きによってこちらのコードと照らし合わせる事でテストします。 200: OK - リクエストは成功し、レスポンスとともに要求に応じた情報が返される。 401: Unauthorized - 認証失敗。認証が必要である。 403: Forbidden - 禁止されている。リソースにアクセスすることを拒否された。 404: Not Found - 未検出。リソースが見つから
【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成 - 独学プログラマ
2020.10.01に公開 2020.10.09に更新 Udemy 12. サーバーサイドのログイン認証 No.4 / 8 今回達成すること JWT（以下、トークン）を検証し、正しければ発行主のユーザーを返すAuthenticatorモジュールを作成します。 モジュールで作成したメソッドは、Railsコントローラーのbefore_actionで読み込みます。 これにより、ログインユーザーしかアクセスできないコントローラーアクションを作成することができます。 モジュールファイルを作成する モジュールファイルは、前回作成した「services/user_auth」ディレクトリ内に作成します。 authenticator.rbを作成しましょう。 root $ touch api/app/services/user_auth/authenticator.rb UserAuthを継承したモジュールを
【Rails×JWT】ログイン認証解説とJWT初期設定ファイルの作成 - 独学プログラマ
2020.10.01に公開 2021.06.09に更新 Udemy 12. サーバーサイドのログイン認証 No.2 / 8 今回達成すること 今回は、ログイン認証の流れを理解し、JWTの実装に入ります。 JWTの初期設定ファイルを作成するところまでをゴールとしましょう。 ログイン認証機能の参考 ここで紹介するログイン機能は、RailsAPIでJWT認証が実装できるGem knockを参考にしています。 Knockは2016年から更新が止まっており、Rails6には対応しなくなりました。（非公式版は2020年も更新あり） そこで今回は、Knockのコードを参考に1からログイン認証を手作りします。 JWTを使ったログイン認証の流れ 今回実装するログイン認証では、以下の手順で認証が行われます。 1. クライアントからログイン情報を投げる まず初めにNuxt.jsからログインに必要な メールアドレ
JSON Web Token(JWT)を用いたAPIの認証の実装(Rails) - Qiita
解決する課題 従来のWebアプリケーションでは、認証情報をCookiesを利用して保持し、ログイン状態を保つことを実現しています。 APIではブラウザを介さないことからCookiesを使用したセッションの保持は行えないため、認証時に生成したトークンを用いて認証済み（ログイン状態）であることを表現できます。 JSON Web Tokenの利用 認証時に生成するトークンは慣例通りJSON Web Token（JWT)を利用します。 Railsでは"jwt"というGemがあるので、簡単に扱うことができます。 アプリケーションによりますが、controller/concernsに認証用モジュールを設け、そこにJWT関連の処理をまとめて記載すると扱いやすいです。 暗号化・復号化の実装 手始めに、暗号化・復号化の実装例は下記のようになります。 app/controller/concerns下に作成して
RailsのAPI開発で使える！JWTを理解して認証機能を実装する！ - Qiita
背景 以前、vue.js × Rails APIでのSPA開発に挑戦しました。その際、認証にJWTを使ったのですが、ネットの記事を参考に実装したために仕組みやコードを完全に理解できていませんでした。そのためJWTの認証について改めて記事にしてまとめたいと思いました。railsでvue,reactなどと連携させてSPA開発したい方は参考になるかと思います。 #目次 JWTについて JWTで認証をする流れ 実際のrailsコード解説 vue.jsとの連携 1. JWTについて ###■JWTとはなにか JWTとはJSON Web Tokenの略で、JSON形式で表されたトークンです。著名・暗号化によってセキュアな通信ができます。 ###■JWTの中身 JWTは下記のうようにピリオド区切りで３つの要素に分かれています。 ①のヘッダー要素は、データの型やルールを指定します。 ②のペイロード要素には
RailsでFace APIを扱うので噛み砕いてみた◎ - Qiita
はじめに RailsでFace APIを扱う記事が少なく実装に一手間かかってしまったので、 初歩的ですが今後同じように開発する方がスムーズに実装できるようにこの記事が手助けになれば幸いです！m(_ _)m この記事に期待できること RailsでFace APIを扱うためのコードを理解できる リクエストするデータについての理解が深まる(おまけ) 前提としてREST APIについての知識があればより理解してもらえると思います。 Face APIについて 本題に入る前にFace APIとは？の説明をしておきます。 Microsoftが提供するAzure APIと呼ばれるサービスの一つです。 公式サイトはこちら Face API詳細についてはこちら 実装にあたりAPIキーを必要とするのでアカウント登録をしておく必要があります。 登録方法は沢山記事があるのでそちらを参考にしてください。 私はこの当た
画像データをサーバーにPOSTする
機械学習を使ったサービス/アプリを開発しているとクライアントから画像をサーバーに送って推論して結果を返す，ということをよくやるのでメモ． 1枚しか送らない場合 今の所自分はこのパターンが多いです．いくつか実現方法はあると思いますが，リクエストボディに直接画像データのバイナリを入れて送る方法がシンプルで好きです．クライアント側のコードはこんな感じ． import json import urllib.parse import urllib.request # read image data f = open("example.jpg", "rb") reqbody = f.read() f.close() # create request with urllib url = "http://localhost:5000" req = urllib.request.Request( url,
Twitter、「開発者契約」を密かに改定し、公式にサードパーティアプリを禁止
米Twitterは1月19日（現地時間）、開発者利用規約「開発者契約」を更新し、サードパーティアプリの提供を公式に制限した。告知はなかった。本稿執筆現在、日本語版はまだ更新されていない。 「ライセンス対象物（APIやコンテンツのこと）を使用またはアクセスして、Twitterアプリの代替または類似のサービスまたは製品を作成すること」を制限すると明示した。つまり、サードパーティアプリの開発を禁止するということだ。 Twitterでは1月12日からサードパーティアプリで問題が発生しているが、Twitterからは何も説明がなかった。 17日にTwitterの開発者対応チームの公式アカウントが「Twitterは、古くからあるAPIルールを施行している。その結果、一部のアプリが動作しなくなる可能性がある」とツイートしたが、「古くからあるAPIルール」が何を指すのかは不明だった。 サードパーティアプリ「
rails のconcernを使ってエラーレスポンスを返す忘備録 - Qiita
concernとは app/concernsというディレクトリが存在する。concernsは ・複数のコントローラー（モデル）から利用される処理を共通化する目的 ・ある特定のまとまった処理を切り出して見通しをよくする目的 上記の目的で使われることが多い。 Concernの書き方 まずはconcernのファイルを記入し、その後コントローラーにてincludeで表記する。 module MyConcern extend ActiveSupport::Concern # Scope や Callbackなどの処理を実装する included do scope :without_deleted, lambda{ where(deleted_at: nil) } end module ClassMethods def foo puts 'foo' end end def bar puts 'bar'
Railsアプリの例外ハンドリングとエラーページの表示についてまとめてみた - Qiita
Railsアプリケーションの例外ハンドリングとエラーページの表示方法については色々な方法があると思いますが、そのなかでもよく使われる方法についてまとめてみました。 前提 Rails 4.2.6 Rails 標準の仕組みで静的ページを表示する Rails は標準では Rack Middleware のActionDispatch::ShowExceptionsの仕組みで例外を捕捉して、エラーページを表示しています。その際、捕捉した例外に対してどんなエラーページを表示するのかをActionDispatch::PublicExceptionsが処理しています。 例えばActionController::RoutingErrorが発生した場合、対応する404のHTMLファイルpublic/404.htmlが表示される、という感じです。 なお、rails generateしたときに用意されるHTML
Rails によるカスタム例外の設定とエラーハンドリング - Qiita
Rails で例外を発生させたい際は，raise...つまり RuntimeError をよく使用するかと思います。 しかし，サービス上の制約から，特定の状況下で例外を発生させる場合，raiseだけでは物足りなくなる時があります。 raiseでは「何かまずいことが起きてしまいました！」程度のことしか伝えてくれません。まぁ，引数に渡す message を見れば理解できるかもですが... 兎にも角にも，特定の状況下に対する例外が存在するなら，その例外に対して名前を付けてあげましょう。 カスタム例外を設定すると，発生時に「何に対する例外か」がパッと理解できるようになりますし，特定の動作に誘導することも容易になりますので，良いことづくめです！ 参考 URL 等 項目22 | Effective Ruby（長尾高弘 arton PeterJ.Jones）｜翔泳社の本 Railsアプリケーションにおけ
RailsのAPIサーバーのエラーレスポンスで例外に対応するエラーコードを返却する - Timee Product Team Blog
はじめましてこんにちは。 夏が本気を出してきて最近麺類しか口にしていないサーバサイドエンジニアのかしまです。 この度APIにてHTTP Status Codeとは別に、例外に対応するエラーコードを返すよう奮闘したのでその知見を共有したいと思います。 やりたいこと APIにて例外が発生した場合、以下の形式でレスポンスを返すようにします。 { "errors": [ { "code": "code1", "message": "message1", }, { "code": "code2", "message": "message2", }, ] } Why？ 今回追加したAPIは外部のアプリケーションとの連携に使うため、以下の要件を満たす必要がありました。 クライアントサイドがハンドリングしやすいような設計にする エラーの識別子は不変であること そのためエラーメッセージとは別に、コードを返す
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Apidog APIの設計、デバッグ、開発、モック、テストを一体化した包括的なプラットフォーム
ChatGPT APIとは？【登録方法 & 使い方】｜サクッと始めるチャットボット【ChatGPT / Python】
WebAPI で multipart/form-data を使う