論文の概要: Developer Perspectives on REST API Usability: A Study of REST API Guidelines
- arxiv url: http://arxiv.org/abs/2601.16705v1
- Date: Fri, 23 Jan 2026 12:45:01 GMT
- ステータス: 翻訳完了
- システム内更新日: 2026-01-26 14:27:27.682497
- Title: Developer Perspectives on REST API Usability: A Study of REST API Guidelines
- Title(参考訳): REST APIユーザビリティに関する開発者の視点: REST APIガイドラインの検討
- Authors: Sven Peldszus, Jan Rutenkolk, Marcel Heide, Jan Sollmann, Benjamin Klatt, Frank Köhne, Thorsten Berger,
- Abstract要約: 業界から16人のREST API専門家にインタビューを行った。
REST APIのユーザビリティに影響を与える8つの要因を特定します。
- 参考スコア(独自算出の注目度): 4.2711788353513835
- License: http://arxiv.org/licenses/nonexclusive-distrib/1.0/
- Abstract: REST is today's most widely used architectural style for providing web-based services. In the age of service-orientation (a.k.a. Software as a Service (SaaS)) APIs have become core business assets and can easily expose hundreds of operations. While well-designed APIs contribute to the commercial success of a service, poorly designed APIs can threaten entire organizations. Recognizing their relevance and value, many guidelines have been proposed for designing usable APIs, similar to design patterns and coding standards. For example, Zalando and Microsoft provide popular REST API guidelines. However, they are often considered as too large and inapplicable, so many companies create and maintain their own guidelines, which is a challenge in itself. In practice, however, developers still struggle to design effective REST APIs. To improve the situation, we need to improve our empirical understanding of adopting, using, and creating REST API guidelines. We present an interview study with 16 REST API experts from industry. We determine the notion of API usability, guideline effectiveness factors, challenges of adopting and designing guidelines, and best practices. We identified eight factors influencing REST API usability, among which the adherence to conventions is the most important one. While guidelines can in fact be an effective means to improve API usability, there is significant resistance from developers against strict guidelines. Guideline size and how it fits with organizational needs are two important factors to consider. REST guidelines also have to grow with the organization, while all stakeholders need to be involved in their development and maintenance. Automated linting provides an opportunity to not only embed compliance enforcement into processes, but also to justify guideline rules with educational explanations.
- Abstract(参考訳): RESTは、Webベースのサービスを提供するための、今日の最も広く使われているアーキテクチャスタイルです。
サービス指向の時代(Software as a Service (SaaS))では、APIは中核的なビジネス資産となり、簡単に数百の操作を公開することができます。
十分に設計されたAPIがサービスの商業的成功に寄与する一方で、設計の不十分なAPIは組織全体を脅かす可能性がある。
それらの関連性と価値を認識して、設計パターンやコーディング標準と同様に、利用可能なAPIを設計するための多くのガイドラインが提案されている。
例えば、Zalando氏とMicrosoftは人気のあるREST APIガイドラインを提供している。
しかし、それらは大きすぎて適用できないと考えられており、多くの企業が独自のガイドラインを作成し、維持しているため、それ自体は課題である。
しかし実際には、開発者は効果的なREST APIの設計に苦慮している。
状況を改善するためには、REST APIガイドラインの採用、使用、作成に関する経験的な理解を改善する必要があります。
業界から16人のREST API専門家にインタビューを行った。
APIのユーザビリティ、ガイドラインの有効性要因、ガイドラインの採用と設計の課題、ベストプラクティスといった概念を決定します。
私たちはREST APIのユーザビリティに影響を与える8つの要因を特定しました。
実際、ガイドラインはAPIのユーザビリティを改善する効果的な手段だが、厳格なガイドラインに対する開発者からの抵抗は大きい。
ガイドラインのサイズと組織のニーズにどのように適合するかは、考慮すべき2つの重要な要素である。
RESTガイドラインは組織と共に成長しなければなりませんが、すべての利害関係者が開発やメンテナンスに関与する必要があります。
自動化リンティングは、コンプライアンス執行をプロセスに組み込むだけでなく、ガイドラインルールを教育的説明で正当化する機会を提供する。
関連論文リスト
- Validating API Design Requirements for Interoperability: A Static Analysis Approach Using OpenAPI [0.0]
APIの品質検証は、技術的設計と要件とエンタープライズアーキテクチャの整合性に寄与する。
S.E.O.R.A.は非機能API要件の早期検証を容易にする。
手動で検査する必要のあるチェックを自動化することで、API設計プロセスを改善する。
論文 参考訳(メタデータ) (2025-11-21T23:15:46Z) - A Systematic Evaluation of Large Code Models in API Suggestion: When, Which, and How [53.65636914757381]
API提案は、現代のソフトウェア開発において重要なタスクである。
大規模コードモデル(LCM)の最近の進歩は、API提案タスクにおいて有望であることを示している。
論文 参考訳(メタデータ) (2024-09-20T03:12:35Z) - WorldAPIs: The World Is Worth How Many APIs? A Thought Experiment [49.00213183302225]
本稿では, wikiHow 命令をエージェントの配置ポリシーに基礎付けることで, 新たな API を創出するフレームワークを提案する。
大規模言語モデル (LLM) の具体化計画における近年の成功に触発されて, GPT-4 のステアリングを目的とした数発のプロンプトを提案する。
論文 参考訳(メタデータ) (2024-07-10T15:52:44Z) - A Conceptual Framework for API Refactoring in Enterprise Application Architectures [0.0]
本稿では,APIの実装に関する概念的枠組みを紹介する。
私たちのフレームワークには重要なトレードオフと選択肢があり、結果として生じるアーキテクチャの効率性、保守性、分離性に大きな影響を与えます。
私たちの作業は、APIを適用する際の摩擦を減らし、よりアーキテクチャ的な選択をオープンにする方法を、初めて示します。
論文 参考訳(メタデータ) (2024-07-10T07:32:16Z) - Leveraging Large Language Models to Improve REST API Testing [51.284096009803406]
RESTGPTはAPI仕様を入力として、機械解釈可能なルールを抽出し、仕様内の自然言語記述からサンプルパラメータ値を生成する。
評価の結果、RESTGPTはルール抽出と値生成の両方において既存の技術よりも優れています。
論文 参考訳(メタデータ) (2023-12-01T19:53:23Z) - Exploring Behaviours of RESTful APIs in an Industrial Setting [0.43012765978447565]
これらのAPIが示す振る舞いの例を生成するために,REST APIに共通する一連の動作特性を提案する。
これらの例は、APIの理解を深めるために(i)、自動テストケースのソースとして(ii)の両方に使用することができます。
提案手法は,システム理解と実践者によるテスト生成の源泉として考えられる例を生成することができる。
論文 参考訳(メタデータ) (2023-10-26T11:33:11Z) - Adaptive REST API Testing with Reinforcement Learning [54.68542517176757]
現在のテストツールは効率的な探索機構がなく、全ての操作とパラメータを等しく扱う。
現在のツールは、仕様にレスポンススキーマがない場合や、変種を示す場合に苦労している。
我々は、強化学習を取り入れた適応型REST APIテスト手法を提案し、探索中の操作を優先順位付けする。
論文 参考訳(メタデータ) (2023-09-08T20:27:05Z) - RestGPT: Connecting Large Language Models with Real-World RESTful APIs [44.94234920380684]
ツール強化された大規模言語モデル(LLM)は、幅広いタスクに対処する上で、目覚ましい進歩を遂げている。
複雑な命令に対処する実践的な課題に対処するために,ロバストネスの力を利用するRestGPTを提案する。
RestGPTを十分に評価するために,実世界の2つのシナリオと人手による指示からなる高品質なベンチマークであるRestBenchを提案する。
論文 参考訳(メタデータ) (2023-06-11T08:53:12Z) - Do RESTful API Design Rules Have an Impact on the Understandability of
Web APIs? A Web-Based Experiment with API Descriptions [4.26177272224368]
参加者105名を対象に,制御型Webベースハイブリッド実験を行った。
私たちは、APIスニペットを使って、12の設計ルールを2つのバージョンで研究しました。
12のルールのうち11のルールにおいて,「違反」は理解作業において「ルール」よりも有意に悪い結果を示した。
論文 参考訳(メタデータ) (2023-05-12T09:48:23Z) - Evaluating Embedding APIs for Information Retrieval [51.24236853841468]
ドメインの一般化と多言語検索における既存のセマンティック埋め込みAPIの機能を評価する。
BM25の結果をAPIを使って再ランク付けすることは、予算に優しいアプローチであり、英語でもっとも効果的である。
非英語検索では、再ランク付けは結果を改善するが、BM25のハイブリッドモデルは高いコストで機能する。
論文 参考訳(メタデータ) (2023-05-10T16:40:52Z)
関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。
指定された論文の情報です。
本サイトの運営者は本サイト(すべての情報・翻訳含む)の品質を保証せず、本サイト(すべての情報・翻訳含む)を使用して発生したあらゆる結果について一切の責任を負いません。