問題タブ [api-doc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
2 に答える
325 参照

web-services - Swagger編集api-docs?

私は残りのWebサービスを開発するのが初めてで、現在、このURLを介して認証を追加しようとしています: http://developers-blog.helloreverb.com/enabling-oauth-with-swagger/

残念ながら、リソース リストを編集するように指示された最初のステップで行き詰まっています。では、サービスによって生成され、どこにもファイルとして保存されていない場合、どのように編集すればよいでしょうか?

私のSwaggerバージョンは1.2です

0 投票する
1 に答える
1468 参照

documentation - apidocjs 応答で何も返さない

次のコマンドを使用して、API ドキュメント用に「npm」と「node」をインストールした後、「apidoc」をインストールしました。

apidoc をグローバルにインストールした後、プロジェクト ディレクトリで以下のコマンドを実行しました (apidoc がデフォルトのテンプレート ファイルを考慮すると仮定します)。

その結果、エラーもドキュメントも生成されませんでした。

同様に、私は試しました:

しかし、何も起こりません。その場合、「mytemplate」ディレクトリには何もありませんでした。

インストール/検討するのに見逃したものを教えてください。コマンドの実行時に何も表示されないのはなぜですか?

注: Ruby アプリケーションにこれを使用していますが、アプリケーションを Ruby 1.9 で実行しており、Ruby 2.0 が必要なため、gem をインストールできません。他のプロジェクトでも機能する独立したソリューションが必要です。

ありがとうございました。

0 投票する
3 に答える
4927 参照

api - Swagger には API の変更履歴をサポートする機能がありますか? またはサポートするオープンソース ライブラリはありますか?

Swagger Editor を使用して、API の詳細を Swagger UI に表示する YAML/JSON コードを生成しています。

API の利用者が、API ドキュメントの改訂履歴 (追加されたフィールド、「オプション」から「必須」に変更されたフィールドなど) を表示できるようにしたいと考えています。この機能は Swagger でサポートされていますか?

0 投票する
2 に答える
1448 参照

documentation - APIDOCJS - バージョン管理の作成方法

私は過去数日間 APIdoc.js をいじっていましたが、バージョニングを機能させる方法がわかりません。APIDOCに従って、古い APIDOC コメント コードを@APIVersioning新しい/古いコードで別のファイルに保存する必要があることを理解しています。この古いファイルをどこに貼り付けても、動作するようには見えず、このバージョン管理を作成するために古いコードをロードする方法について、この例には何のヒントもありません。支援された方は大歓迎です。

0 投票する
2 に答える
460 参照

php - アノテーションをバイパスする Symfony2

現在、Symfony2 を使用して RESTful API を構築しています。

シンプルでクリーンなドキュメントを作成するために、私はapidoc.jsを使用したいと考えています(私はこれを使用したいと思っていますが、API ドキュメントを自動生成するものが他にある場合は、自由に共有してください)。

このジェネレーターは、Symfony カーネルによって解析される注釈を使用します (明らかに、私が理解していることから)

これがコントローラーの私のコードです

悲しいことに、Symfony はこれを解析し、エラーをスローします:

Symfony が注釈を解析するのを防ぐ (私は常に YAML を使用しているため、Symfony の注釈は実際には役に立たない) か、単にそれらをインポートするための解決策がありますか?

私はこれにまったく慣れておらず、信頼性の高いクリーンな Symfony アプリケーションの作成にまだ苦労しています。

0 投票する
0 に答える
366 参照

api - タイプ「ファイル」のswagger api-doc検証が失敗する

以下は私の闊歩の定義です:

editor.swagger.io で API ドキュメントを検証しようとすると、次のエラーが発生します。何かご意見は?

0 投票する
1 に答える
700 参照

swagger - Swagger を使用して Spring OAuth 2.0 API を文書化する

Spring セキュリティを使用して OAuth 2.0 承認サーバーのセットアップに取り組んでいます。Swagger を使用して OAuth 2.0 API を文書化したいと思います。どうすればいいですか?

0 投票する
2 に答える
96 参照

php - ZF1 api doc で何かの特定の意味を見つける方法

このような Zend_Form:

ZF1 1.12 API とリファレンス ドキュメントを読みましたが、Zend_Form::addElement() 構成オプションの「無視」フラグの意味がわかりません。

API ドキュメントは次のとおりです。 ここに画像の説明を入力

確かに私はそれをグーグルで見つけて見つけましたが、これはうまくいく方法ではありません。特定の特定のものの意味を見つける方法. ソースコードを読む必要はないと思いますか?

これaddElement()を例として取り上げてください。さらに調べる場所がありませんか?Zend_Configignoreクラスには、フラグについても何も見つかりません。