REST API Common Spec としての HTTP Status Code と Error の提案 - Affamative Way
この記事は Timee Advent Calendar 2023 シリーズ 2 の14日目の記事です。 qiita.com はじめに TL;DR API HTTP Response Code Definition 2xx 4xx 5xx Errors Problem Details まとめ We’re Hiring! はじめに CTO室に10月に入社した id:cos31 です。 色々とやり始めたばかりで、ネタに苦しいので仕事にもタイミーには全く関係のないネタになります！*1 TL;DR RFC 9457 - Problem Details for HTTP APIs と RFC 9205 - Building Protocols with HTTP をあわせて使うとすっきりする インフラレイヤーとアプリレイヤー HTTP Status code が棲み分けできるステキ感 エラーメッセージ
package main import ( "go_example/model" "net/http" "time" "github.com/labstack/echo" "github.com/objectbox/objectbox-go/objectbox" ) func main() { e := echo.New() e.POST("/add", addFavorite) e.Logger.Fatal(e.Start(":1323")) } func addFavorite(c echo.Context) error { favorite := new(AddFavoriteRequest) // データ受け取り if error := c.Bind(favorite); error != nil { return error } // initialize ob := initO
GraphQLとは何か？ イメージを掴む
はじめに 今回の記事ではGraphQLについて、公式などを参考にしながら基本的なことをまとめてみました。 自分自身GraphQLのキャッチアップを始めるときに こんなこと知っときたかったなあ、ということをまとめたので これからGraphQLの勉強を始める方や興味のある方はよかったら読んでみてください。 大枠を掴むことをイメージして書いており、深い部分の説明を省いている箇所もあるので その点はご了承ください。 そもそもGraphQLとは？ GraphQLはAPIのクエリ言語です。 クエリ言語というとSQLが有名ですが、SQLがデータベースに対してクエリを実行するのに対し、 GraphQLはAPIに対してクエリを実行します。 ちなみに、プログラミングにおけるクエリとは データに対する問い合わせや要求などを一定の形式で文字に表現すること、 要は所定の形式で対象のデータにやりたいことを伝えること、
最近、TypeScript + tsoa + express + TypeORM というような技術スタックでバックエンドの Web API 開発しています。 tsoa という軽量な Web フレームワークを使っているんですが、OpenAPI の自動生成をしてくれるので、実装と API 仕様書の齟齬がなく快適に開発ができています。この記事では、TypeScript + tsoa + express + TypeORM を使って簡単な Web API を作成してみたいと思います。 tsoa とは tsoa とは、TypeScript のコードから OpenAPI 定義の自動生成と express、koa、hapi と統合できる Web フレームワークです。TypeScript のデコレータを使ってコントローラークラスに付与して開発します。なんらかの MVC フレームワークを使ったことがある方は
Template String Types でパス文字列を解析してクエリする - Object.create(null)
※この記事に含まれる内容は TypeScript 4.1 のプレビュー版のものです. 今後仕様が変わり動かなくなる可能性もありますのでご注意ください. 話題の template string types で早速遊んでみます. ゴール .foo[1].bar といった形のパス文字列を型レベルで解析してクエリしちゃいます. こういう感じ: type R1 = Query<{ foo: number }, "">; // R1 = { foo: number } type R2 = Query<{ foo: number }, ".foo">; // R2 = number type R3 = Query<[number, string, boolean], "[1]">; // R3 = string type R4 = Query<{ foo: { bar: string } }, ".fo
GitHub - alufers/mitmproxy2swagger: Automagically reverse-engineer REST APIs via capturing traffic
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
GitHub - vitalik/django-ninja: 💨 Fast, Async-ready, Openapi, type hints based framework for building APIs
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
今度こそ (REST) API Gateway と仲良くなるための個人的まとめ | DevelopersIO
はじめに おはようございます、もきゅりんです。 早速ですが、当記事では、API Gatewayの使い方の詳細や、こんな使い方が良き、というお話は一切ありません。 API Gateway(RESTに限った話です)と仲良くなりたいわたしによる、API Gatewayの全体像の捉え方を個人的にまとめたものとなります。 他の方にお役に立つかどうかは分かりません。。 でも、もしあなたがわたしと同じように、API Gatewayと仲良くなりたいとは思っているんだけど、ドキュメント読んだり他の人の紹介記事を見て実際にやってみたりしても分かったような気がするけど、仲良くなった気がしない、、という方は、一助になるかもしれません。 ということで、いちおうAPI Gatewayがどんなものか何となくは把握されている方が対象です。 単純化してイメージしてみる 物事の学習において肝要なのは、まず全体像を把握すること
Ruby3.0 からは、型定義を処理するための rbs gem が同梱されていて、これは外部の *.rbs ファイルに記述した内容に従って、Rubyコードの型チェックを可能にしてくれる。 github.com 最近、この RBS の型定義を TypeScript の型定義に変換できないかな〜と思い、 rbs2ts という gem を実験的に作ってる。 結構荒削りなので、細々した部分での挙動は正直怪しいが、ある程度それっぽく動くようになったので公開してある。 rubygems.org github.com Gemのいまのところの挙動 いまのところ次のような変換ができる Alias RBS type TypeofInteger = Integer type TypeofFloat = Float type TypeofNumeric = Numeric type TypeofString =
Wasp
app todoApp { title: "ToDo App", // visible in the browser tab auth: { // full-stack auth out-of-the-box userEntity: User, methods: { google: {}, gitHub: {}, email: {...} } } } route RootRoute { path: "/", to: MainPage } page MainPage { authRequired: true, // Limit access to logged in users. component: import Main from "@client/Main.tsx" // Your React code. } query getTasks { fn: import { getTasks
Hoppscotch • Open source API development ecosystem • Hoppscotch
ParametersBodyHeadersAuthorizationPre-request ScriptTestsVariables
Obsidian Authenticator has been renamed "Sentinel"For too many times we have been confused with the "Obsidian note-taking app". Same team, same purpose. We only thought we deserved our own identity.
クラウド上で動作するアプリケーションの管理・デプロイフレームワーク「Apache Brooklyn 1.0」リリース | OSDN Magazine
Apache Brooklynはクラウド上で動作する分散型アプリケーションのモデリングおよびモニタリング、管理のためのフレームワーク。2015年にApache Software Foundationのトップレベルプロジェクトとなっていた。自律型コンピューティングに着想を得ており、クラウドアプリケーションの管理仕様である「OASIS CAMP」やデプロイのための仕様である「TOSCA」の両標準をサポートしている。 YAML形式でアプリケーションの情報やデプロイ・実行に必要なコンポーネントの情報、デプロイ時に必要となる処理などを記述（モデリング）することで、それを元にアプリケーションのデプロイや管理を行える。デプロイ・管理できるプラットフォームとしてはAmazon EC2など20種類以上のパブリッククラウドをサポートしており、プライベートクラウドやベアメタル環境でも利用できる。REST API
GitHub - contiamo/restful-react: A consistent, declarative way of interacting with RESTful backends, featuring code-generation from Swagger and OpenAPI specs 🔥
⚠️ restful-react has been deprecated: We are focusing on a new open api generator that generates react-query components: https://github.com/fabien0102/openapi-codegen ⚠️ Building React apps that interact with a RESTful API presents a set of questions, challenges and potential gotchas. This project aims to remove such pitfalls, and provide a pleasant developer experience when crafting such applicat
navigation Migrate an existing applications RESTful API’s to GraphQL using AWS Amplify and AWS AppSync Welcome! In this workshop you will take an existing stock trading application written with React and AWS Amplify. you will convert its existing RESTful API from REST ( Amazon API-Gateway ) to using GraphQL ( AWS AppSync ). In doing so you will also explore the benefits that GraphQL API's have ove
Today we’re excited to announce the availability of TypeScript 4.2 Beta! To get started using the beta, you can get it through NuGet, or use npm with the following command: You can also get editor support by Downloading for Visual Studio 2019/2017 Following directions for Visual Studio Code and Sublime Text. Let’s take a look at what’s in store for TypeScript 4.2! Leading/Middle Rest Elements in T
GitHub - YadaYuki/omochi: Full text search engine from scratch by Goʕ◔ϖ◔ʔ (Just a toy) 😊
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
関連キーワード API | アプリケーション開発 とどまることのないデータの増加に直面する開発者にとって、データの処理速度を上げる技術は有用だ。クエリ（データ操作）言語「GraphQL」は、API（アプリケーションプログラミングインタフェース）の構築をシンプルにし、データ取得の流れを明確に表現することで、データの迅速な処理を可能にする。 データ連携のための枠組みを定義したアーキテクチャには他に「REST」（Representational State Transfer）が存在する。以下でGraphQLのメリットや、RESTと比較した場合の強みと弱みを紹介しよう。 併せて読みたいお薦め記事 GraphQLの活用 Netflixがクエリ言語「GraphQL」を採用 何にどう使っているのか Netflixが「REST」をやめて「GraphQL」に乗り換えた理由 RESTはオワコンか、クエリ言語は
RubyGemパッケージrest-client、バックドアを含むバージョンが立て続けに公開される | スラド セキュリティ
RubyGemパッケージ「rest-client」のメインテナーのRubyGem.orgアカウントが不正アクセスを受け、悪意あるコードを含むバージョンが立て続けに公開されていたそうだ(rest-client Issue#713、 The Registerの記事、 CVE-2019-15224)。 不正に公開されたのはバージョン1.6.10/1.6.11/1.6.12/1.6.13の4バージョン。1.6.13では外部にデータを送信するコードをpastebinからダウンロードして実行するコードが含まれていたという。1.6.x系列は2014年に1.7.0で置き換えられた非常に古いバージョンで、何らかの理由により最新版へアップグレードできない場合のために残されているものだが、1.6.13は1,061回ダウンロードされていたそうだ。 不正アクセスを受けたメインテナーのHacker Newsへの投稿に
はじめに このドキュメントは、SPA＋REST APIで構築したシステムの認証方法を、事例としてまとめたものになります。 本ドキュメントが、SPA＋REST APIにおける認証の実現方式のひとつとして、今後開発を行うシステム、プロジェクトの参考情報となることを目的としています。 なお、このドキュメントに記載しているシステムは開発中のものであり、実際に運用されているシステムではありません。その点については、ご留意のうえ、構成例としてドキュメントを参照いただければと思います。 このドキュメントは、SPA＋REST APIのシステム構成例（AWS）のアプリケーションの認証部分にフォーカスして記載したものです。 以下のような用語についての説明は、本ドキュメントでは行いません。事前に知識を持っている、もしくは必要に応じて他の資料、情報などを参照していただくことを前提とし、構築したアプリケーションと方
F5 iControl REST Endpoint Authentication Bypass Technical Deep Dive – Horizon3.ai
Early in 2023, soon after reproducing a remote code execution vulnerability for the Fortinet FortiNAC, I was on the hunt for a set of new research targets. Fortinet seemed like a decent place to start given the variety of lesser-known security appliances I had noticed...
その「ちょうどよさ」ゆえに普及したテクノロジ - アイデアや標準があると思う。 そういうのは、科学や工学でなく匠としてのプログラミングを表している気がして成功が嬉しい。 自分にとって「ちょうどいいテクノロジ」の代表は JSON (2002) と Markdown (2004). どちらも技術的にはさほど大したことはないけれど、どちらも広く使われている。 「ちょうどいいテクノロジ」はこれ以前にも色々あった。UNIX(1969) や HTTP/REST (1991) なんかが思い当たる。 ただ同時代性がないせいか成功が華やかすぎるせいか、まいち親近感がない。 ついでにいうと、自分はもはやこれらに「ちょうどよさ」を感じない。 UNIX の代表 Linux は超巨大ソフトウェアだし、HTTP の最新版 HTTP/3 は随分複雑なプロトコルに見える。 JSON と Markdown は、今のところ当
雑なメモ書きの様な内容です。 自分の知識、知恵の引き出しの整理も兼ねてます。 実践的で有用な対応パターンをまとめました。 HTTP Method with URI| http method | explain | URI | |GET| ドキュメントリソースの取得| https://api.example.com/v1/items/1 | |GET| コレクションリソースの取得| https://api.example.com/v1/items | |POST| リソースの作成 | https://api.example.com/v1/items | |PUT| リソースの更新 | https://api.example.com/v1/items/1 | |PATCH| リソースの部分更新 | https://api.example.com/v1/items/1 | |DELETE| リソ
WordPressサイトをWP REST API + Nuxt.jsでリニューアルした際のポイントまとめ | ブログ | Glatch（グラッチ） - 夫婦で活動するフリーランスWeb制作ユニット
先日Glatchのポートフォリオサイトをリニューアルしました。 前回の記事では妻がポートフォリオの設計・デザインプロセスに関して投稿してくれました。 今回は実装編です。 普段は技術系の記事はテックブログに書いているのですが、ポートフォリオの宣伝も兼ねているので今回はこちらに投稿します。良かったらテックブログも見ていただけると嬉しいです。 さて技術面に関してはせっかくリニューアルするのでこの機会に新しい技術を試したい、でもWordPressで管理してきた資産はできればそのまま活かしたい、という2つの要望が自分の中にありました。 この2つを両立させるためにコンテンツ管理には引き続きWordPressを使用し、フロント部分にモダンなフレームワークを採用することで要望を満たしました。 検討の結果WP REST API + Nuxt.jsというJAMstackな構成で構築することにしました。 本記事
Improved REST API documentation
ProductImproved REST API documentationWe’re excited to announce some big improvements to our REST API documentation. We know developers rely on this documentation to integrate with GitHub, and we are committed to making it trustworthy, easy to find, and easy to use. We’re excited to announce some big improvements to our REST API documentation. We know developers rely on this documentation to integ
DjangoRESTFramework (以降 DRF という) を最近良く使っているのですが 設定項目が多すぎて情報探すのに時間がかかっちゃうので、自分なりにまとめてみました。 2月の後半くらいに書いてたんですが、ブログの改修に時間がかかりすぎて公開が遅れたのは内緒。 個人的な感覚ですが、このライブラリの機能を大きく分けると Serializer, View に分かれます。 本当は全部通しで書きたかったんですが、長くなりすぎたので View の部分は別の記事に分割します。 infoビュー については View の使い方をまとめてみた を参照してください。初めて触る方は 先にビュー編を見ることをオススメします。 シリアライザ単体で使うことはまずないと思うので。この記事の先頭に書いてあったインストールの手順とかはそちらの記事に移動しました基本的に情報は v3.7.7 時点の 公式ドキュメント
はじめに REST とは RESTful とは RESTish とは まとめ はじめに REST と RESTful 、さらに最近では RESTish という用語についてのまとめです*1。 REST とは REST(REpresentational State Transfer)という言葉が何を指すかは、かなり発散する話題です。 元となるのは Roy Fielding により示されたアーキテクチャスタイルで、アーキテクチャによる制約により以下のように導出されました。 このようなアーキテクチャの制約により導出された REST は、以下のスタイル(制約)を持つものとされています。 Client-Server Stateless Cache Uniform Interface Layered System Code-On-Demand ほとんどは読んだままですが、Code-On-Demand は
冪等と安全に関する誤解 - Qiita
3. 副作用 冪等、安全、キャッシャブルのセクションに入る前に、まず「副作用」について解説します。 2014 年 6 月に廃止された RFC-2616 の「9.1 安全と冪等メソッド」のセクション では、「副作用（side effects）」という表現が使用されてきましたが、多くの方は、この「副作用」のことを、「リソースの状態の変化」と解釈されてきたことと思います。[ 1 ] 特に関数型プログラミングにおいては頻出する表現ですが、ソフトウェア工学的にも コンピューターの論理的な状態を変化させ、以降の結果に影響を与えること [ 2 ] とされています。 しかし、HTTP の「冪等と安全」の解釈の混乱を招いてきた要因 [ 3 ] の一つのは、この「副作用」の表現方法が適切ではなかった、ということではないでしょうか。 以下では、その理由について解説しますが、その必要のない方はこのセクションはスキ
To infinity and beyond: enabling the future of GitHub's REST API with API versioning
EngineeringProductTo infinity and beyond: enabling the future of GitHub’s REST API with API versioningWe’re introducing calendar-based versioning for our REST API, so we can keep evolving our API, whilst still giving integrators a smooth migration path and plenty of time to update their integrations. Millions of developers rely on the GitHub API every day—whether they’ve built their own bespoke in
背景 転職してサーバサイドエンジニアとして、RESTfulなWebAPIドキュメント書く機会が増えた。 RESTの歴史はそれなりに長いため、仕様書の書き方にもベストプラクティスが確立されている。 なので、今更感もあるが、せっかくなのでまとめてみようと思う。 心構え 出来の良いAPI仕様書をマネすること ユーザの対象を意識すること（社内利用か社外利用など。仕様書で意識するポイントが変わるため） トリッキーな使い方をするエンドポイントは疑う 最低限記載すること 共通項目 ドキュメントのメタ情報（バージョン、更新日付など） 常に必要なパラメータ（認証系） 流入制限 エンドポイント（URI） HTTPメソッド（GET、POST、PUT、DELETE、HEAD、OPTIONS、TRACE、CONNECT） Description（概要） Notes（備考） リクエストについて パラメータ（クエリパラ
GitHub - ardatan/feTS: TypeScript HTTP Framework focusing on e2e type-safety, easy setup, performance & great developer experience
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
プリミティブな型としては、 integer, number, string, boolean の4種類のみです。 さらに format というプロパティを指定すると、値の詳細なフォーマットを定義することができます。 int32, int64, float, double あたりは言わずもがなですね。 string に関しては byte と binary の他に、ISO 8601（RFC3339）で定義されている日付形式が表現可能です。 基本形式: 20191129T203637+0900 拡張形式: 2019-11-29T20:36:37+09:00 password はいまいちよく分かりません。 OASとして定義されているフォーマットは以上なのですが、 format には他にも自由に値を設定することができます。 email や uuid, uri, hostname, ipv4, ipv
PRODUCTHasura Product OfferingsChoose from our Open Source Community Edition, fully-managed Hasura Cloud or on-prem Hasura Enterprise Edition.
REST API Generator
Will my API persist data?Yes, your API has GET, PUT, POST, PATCH, and DELETE endpoints for reading + writing to your dataset. Writes are persisted. How long will my API be available for?Your sample API will be available as long as you continue using it. We may delete it if it hasn’t been used in the last 30 days - please contact us if that is a concern for your use case. Can I use my API outside R
外部システムからSalesforceのREST API を使用してみる 接続アプリケーションの作成から標準REST APIをコールするまで。 Apex REST Webサービスおよび Apex REST コールアウトはここでは扱いません。 1. インテグレーション用ユーザの作成 REST APIを使用するためにはまず、インテグレーション用ユーザを作成する必要があります。 外部システムからSalesforceのREST APIを使用する際は、まずインテグレーション用ユーザにログインする必要があります。 外部システムはインテグレーション用ユーザの権限、共有設定によって制限を受けます。 インテグレーション用にユーザとプロファイルを作成します。 インテグレーション用プロファイルでシステム管理者権限の「API の有効化」が有効になっているのを確認します。 参考 実装に関する考慮事項 | SOAP A
REST API用のファジングツール “RESTler” で始めるお手軽ファジング | IIJ Engineers Blog
IIJイノベーションインスティテュートの四谷です。普段はWeb API開発の生産性向上についての調査や開発を行っています。 今日はREST APIのテスト効率を改善するツール「RESTler」を紹介します。 RESTlerについて RESTlerはMicrosoft Researchが開発し、OSSとして公開しているREST API用のファジングツール（ファザー）です。 ファジングはネットワークプロトコルの実装等、もう少し下位レイヤーでの活用が主で、APIに対して実行できるファザーは数少ないのですが、その1つがRESTlerです。Microsoftでは実際にRESTlerを使用して、AzureやOffice365のバグを検出したそうです。 特長 RESTlerの最大の特長は、OpenAPIドキュメントとして記述されたAPI仕様さえあれば、自動的にテストケースが生成され、ファジングを実行でき
Spring BootによるAPIバックエンド構築実践ガイド 第2版 何千人もの開発者が、InfoQのミニブック「Practical Guide to Building an API Back End with Spring Boot」から、Spring Bootを使ったREST API構築の基礎を学んだ。この本では、出版時に新しくリリースされたバージョンである Spring Boot 2 を使用している。しかし、Spring Boot3が最近リリースされ、重要な変...
真のREST
Node.js server side render in the Age of APIs - Full Stack Toronto 2017Ruy Adorno
And we’re back! As we mentioned in the first part of our blog post series, Instagram Server is a Python monolith with several million lines of code and a few thousand Django endpoints. This post is about how we use types to document and enforce a contract for our Python HTTP APIs. In the next few weeks, we’ll share details on more tools and techniques we’ve developed to manage our codebase’s quali
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
【第10回】Go言語（Golang）入門～ObjectBox活用編～ – 株式会社ライトコード
軽量なWebフレームワークtsoaを使って、OpenAPIとexpressルーティングを自動生成する
RBSからTypeScriptに変換するGem (rbs2ts) を作ってる - memo_md
Obsidian - 2FA / MFA Authenticator
REST to GraphQL Workshop :: AppSync Workshop
Announcing TypeScript 4.2 Beta - TypeScript
「GraphQL」に移るべき人、「REST」を使い続けるべき人を分ける条件
SPA＋REST APIにおけるセッションを使った認証の実践例 | Fintan
ちょうどよさのはなし / morrita - Message Passing
REST WebAPIのプラクティス｜yamarkz - Kazuki Yamaguchi
[Django REST Framework] Serializer の 使い方 をまとめてみた
ウチの「NAS」はめっちゃポケモンに詳しい！【イニシャルB】
REST と RESTful と RESTish について - A Memorandum
APIドキュメントの書き方をまとめてみる - あらにわ
そのフィールド、nullable にしますか、requiredにしますか - Qiita
GraphQLとREST | GraphQLチュートリアル
外部システムからSalesforceのREST API を使用する - Qiita
フルスタック開発者のためのBallerina: バックエンドAPI開発ガイド
Types for Python HTTP APIs: An Instagram Story