{"id":8856,"date":"2016-09-23T11:21:15","date_gmt":"2016-09-23T11:21:15","guid":{"rendered":"https:\/\/dev.railscarma.com\/generate-swagger-docs-rails-api\/"},"modified":"2024-01-10T13:06:39","modified_gmt":"2024-01-10T13:06:39","slug":"generate-swagger-docs-rails-api","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e6%8a%80%e8%a1%93%e8%ab%96%e6%96%87\/generate-swagger-docs-rails-api\/","title":{"rendered":"Rails API \u7528\u306e Swagger Docs \u3092\u751f\u6210\u3059\u308b\u65b9\u6cd5"},"content":{"rendered":"<div data-elementor-type=\"wp-post\" data-elementor-id=\"8856\" class=\"elementor elementor-8856\" data-elementor-post-type=\"post\">\n\t\t\t\t\t\t<section class=\"elementor-section elementor-top-section elementor-element elementor-element-1881e8cb elementor-section-boxed elementor-section-height-default elementor-section-height-default\" data-id=\"1881e8cb\" data-element_type=\"section\">\n\t\t\t\t\t\t<div class=\"elementor-container elementor-column-gap-default\">\n\t\t\t\t\t<div class=\"elementor-column elementor-col-100 elementor-top-column elementor-element elementor-element-7b5d3078\" data-id=\"7b5d3078\" data-element_type=\"column\">\n\t\t\t<div class=\"elementor-widget-wrap elementor-element-populated\">\n\t\t\t\t\t\t<div class=\"elementor-element elementor-element-11b15946 elementor-widget elementor-widget-text-editor\" data-id=\"11b15946\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<p>Rails\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u306eAPI\u3092\u4f5c\u308b\u306e\u306f\u3001Ruby on Rails\u958b\u767a\u8005\u306b\u3068\u3063\u3066\u306f\u7c21\u5358\u3060\u3002\u3044\u305a\u308c\u306b\u305b\u3088\u3001\u9867\u5ba2\u5074\u306e\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u304c\u306a\u3051\u308c\u3070\u3001API\u304c\u6b63\u5e38\u306b\u52d5\u4f5c\u3057\u3066\u3044\u308b\u304b\u3069\u3046\u304b\u3092\u3055\u307e\u3056\u307e\u306a\u9867\u5ba2\/\u9867\u5ba2\u304c\u3069\u3046\u3084\u3063\u3066\u77e5\u308b\u3053\u3068\u304c\u3067\u304d\u308b\u3067\u3057\u3087\u3046\u304b\u3002Rails\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u5185\u306eAPI\u3092\u30ec\u30dd\u30fc\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u7b54\u3048\u306f\u3042\u308a\u307e\u3059\u304b\uff1f\u7b54\u3048\u306f\u30a4\u30a8\u30b9\u3067\u3059\u3002<\/p>\n<p>\u3053\u306e\u8a18\u4e8b\u3067\u306f\u3001swagger UI\u3092\u4f7f\u3063\u3066Rails API\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u4f5c\u6210\u3059\u308b\u65b9\u6cd5\u3092\u516c\u958b\u3057\u307e\u3059\u3002<\/p>\n<p>\u524d\u63d0\u6761\u4ef6<br>\u3053\u3053\u3067\u306f\u3001API\u30b3\u30fc\u30eb\u3092\u63d0\u4f9b\u3059\u308b\u6295\u7a3f\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u306e\u30b5\u30f3\u30d7\u30eb\u3092\u4f7f\u7528\u3059\u308b\u3002<\/p>\n<p>\u5b9d\u77f3<br>swagger UI\u3092Rails API\u306b\u7d71\u5408\u3059\u308b\u306b\u306f\u3001swagger-docs\u3068\u3044\u3046gem\u3092\u4f7f\u3044\u307e\u3059\u3002\u3053\u306egem\u3092\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u306eGemfile\u306b\u8ffd\u52a0\u3057\u3001bundle install\u3057\u307e\u3059\u3002<\/p>\n<p>Swagger\u30a4\u30cb\u30b7\u30e3\u30e9\u30a4\u30b6\u30fc\u30d5\u30a1\u30a4\u30eb:-)<br>gem\u3092\u30d0\u30f3\u30c9\u30eb\u3057\u305f\u5f8c\u3001config\/initializers(swagger.rb\u306a\u3069)\u306b\u30a4\u30cb\u30b7\u30e3\u30e9\u30a4\u30b6\u3092\u4f5c\u6210\u3057\u3001\u4ee5\u4e0b\u306e\u30aa\u30d7\u30b7\u30e7\u30f3\u3092\u6307\u5b9a\u3057\u307e\u3059\uff1a<\/p>\n<pre><code>#\u30d5\u30a1\u30a4\u30eb config\/initializers\/swagger.rb\n  Swagger::Docs::Config.register_apis({\u300d\u3092\u8ffd\u52a0\u3057\u307e\u3059\u3002\n  \"1.0\" =&gt; {\n    #API\u306b\u4f7f\u7528\u3059\u308b\u62e1\u5f35\u5b50\n    :api_extension_type =&gt; :json\u3001\n    # .json\u30d5\u30a1\u30a4\u30eb\u304c\u66f8\u304d\u8fbc\u307e\u308c\u308b\u51fa\u529b\u5148\n    :api_file_path =&gt; \"public\/apidocs\"\u3001\n    #\u3042\u306a\u305f\u306eAPI\u3078\u306eURL\u30d9\u30fc\u30b9\u30d1\u30b9\n    :base_path =&gt; \"http:\/\/localhost:3000\"\u3001\n    1\u4e16\u4ee3\u3054\u3068\u306b\u3059\u3079\u3066\u306e.json\u30d5\u30a1\u30a4\u30eb\u3092\u524a\u9664\u3059\u308b\u5834\u5408\u3001#\n    :clean_directory =&gt; true\u3068\u3057\u307e\u3059\u3001\n    # api-docs\u306b\u30ab\u30b9\u30bf\u30e0\u5c5e\u6027\u3092\u8ffd\u52a0\u3057\u307e\u3059\u3002\n    :attributes =&gt; {\n      :info =&gt; {\n        \"title\" =&gt;; \"\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u306e\u30bf\u30a4\u30c8\u30eb\"\u3001\n        \"description\" =&gt;; \"Swagger UI\u306b\u3088\u308bRails API\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\"\u3001\n        \"termsOfServiceUrl\" =&gt; \"\"\u3001\n        \"contact\" =&gt; \"\"\n       }\n     }\n  }\n})\n<\/code><\/pre>\n<p>\u30b3\u30f3\u30d5\u30a3\u30ae\u30e5\u30ec\u30fc\u30b7\u30e7\u30f3\u306e\u4e00\u89a7\u306f\u4ee5\u4e0b\u306eURL\u3092\u53c2\u7167\u3002<br>https:\/\/github.com\/richhollis\/swagger-docs#configuration-options<\/p>\n<p>swagger_controller\u3068swagger_API\u306f\u3001swagger UI\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u63d0\u4f9b\u3059\u308b\u30d8\u30eb\u30d1\u30fc\u3067\u3059\u3002<\/p>\n<pre><code>\n\u30e2\u30b8\u30e5\u30fc\u30ebApi\n\n\u30e2\u30b8\u30e5\u30fc\u30eb V1\n\n  class PostsController &lt; ApplicationController\n\n         response_to :json\n         swagger_controller :posts, &#039;\u6295\u7a3f\u30b3\u30f3\u30c8\u30ed\u30fc\u30e9\u30fc&#039;\n         swagger_api :create do\n               summary &#039;\u6295\u7a3f\u3092\u4f5c\u6210\u3059\u308b&#039;\n               notes &#039;\u6295\u7a3f\u306e\u4f5c\u6210\u306b\u4f7f\u7528\u3059\u308b&#039;\n               param :form, &#039;\u6295\u7a3f[\u540d\u524d]&#039;, :string, :required, &#039;\u540d\u524d&#039;\n               param :form, &#039;post[publish]&#039;, :boolean, :required, &#039;\u516c\u958b&#039;\n          \u7d42\u4e86\n          swagger_api :index do\n                summary &#039;\u3059\u3079\u3066\u306e\u6295\u7a3f\u3092\u53d6\u5f97\u3059\u308b&#039;\n                notes &#039;\u3059\u3079\u3066\u306e\u6295\u7a3f\u3092\u53d6\u5f97\u3059\u308b\u305f\u3081\u306b\u4f7f\u7528\u3059\u308b&#039;\n                param :header, :Authoraization, :string, :required, &#039;\u8a8d\u8a3c&#039;.\n                \u30ec\u30b9\u30dd\u30f3\u30b9 :unauthorized\n                response :ok, &quot;\u6210\u529f&quot;\n          \u7d42\u4e86\n          swagger_api :show do\n                summary &#039;\u3059\u3079\u3066\u306e\u6295\u7a3f\u3092\u53d6\u5f97\u3059\u308b&#039;\n                notes &#039;\u6295\u7a3f\u3092\u53d6\u5f97\u3059\u308b\u969b\u306b\u4f7f\u7528\u3059\u308b&#039;\n                param :path, :id, :string, :id\n                \u30ec\u30b9\u30dd\u30f3\u30b9 :unauthorized\n                response :ok, &quot;\u6210\u529f&quot;\n           \u7d42\u4e86\n           swagger_api :destroy do\n                 summary &#039;\u6295\u7a3f\u3092\u7834\u68c4\u3059\u308b&#039;\n                 notes &#039;\u6295\u7a3f\u3092\u7834\u68c4\u3059\u308b\u969b\u306b\u4f7f\u7528\u3059\u308b&#039;\n                 param :path, :id, :string, :id\n                 \u30ec\u30b9\u30dd\u30f3\u30b9 :unauthorized\n                 response :ok, &quot;\u6210\u529f&quot;\n            \u7d42\u4e86\n       \u7d42\u4e86\n   \u7d42\u4e86\n\u7d42\u4e86\n<\/code><\/pre>\n<p>\u5143\uff1a-<\/p>\n<pre><code>param :header, :Authoraization, :string, :required, '\u30ea\u30af\u30a8\u30b9\u30c8\u3092\u8a8d\u53ef\u3059\u308b\u3002\nparam :path, :id, :integer, :required, '\u30ec\u30b3\u30fc\u30c9\u3092\u53d6\u5f97\u3059\u308b\u6295\u7a3fID'\nparam :form, :name, :string, :optional, '\u6295\u7a3f\u306e\u540d\u524d'.\nparam :query, :query_name, :string, :optional, '\u30af\u30a8\u30ea\u540d' \u3092\u6307\u5b9a\u3057\u307e\u3059\u3002<\/code><\/pre>\n<p>param - \u6a19\u6e96 API \u30d1\u30e9\u30e1\u30fc\u30bf\uff0e<\/p>\n<pre><code> \u6700\u521d\u306e\u5024: parameter_type(\u30bf\u30a4\u30d7: form, path, header, query)\n2\u756a\u76ee\u306e\u5024: \u30d1\u30e9\u30e1\u30fc\u30bf\u306e\u540d\u524d\n 3\u756a\u76ee\u306e\u5024: \u30d1\u30e9\u30e1\u30fc\u30bf\u306e\u30c7\u30fc\u30bf\u578b\n 5\u756a\u76ee\u306e\u5024: \u5fc5\u9808\/\u4efb\u610f\n 5\u756a\u76ee\u306e\u5024\u30d1\u30e9\u30e1\u30fc\u30bf\u306b\u95a2\u3059\u308b\u5c0f\u3055\u306a\u8aac\u660e\n 6\u756a\u76ee\u306e\u5024: \u5217\u6319\u578b\u3092\u8868\u3059\u62ec\u5f27\u5185\u306e\u5024\u306e\u30ea\u30b9\u30c8(\u30aa\u30d7\u30b7\u30e7\u30f3)<\/code><\/pre>\n<p>\u5217\u6319\u578b\u3092\u6271\u3046\u306b\u306f<br>\u5217\u6319\u578b\u306e\u5024\u306e\u30ea\u30b9\u30c8\u3092\u6e21\u3059\u3002<br>\u5143\uff1a-<\/p>\n<pre><code>param_list :form, :payment_type, :string, :required, '\u652f\u6255\u3044\u30bf\u30a4\u30d7'\u3001\n[:\u5c0f\u5207\u624b\u3001:\u73fe\u91d1\u3001:\u96fb\u4fe1\u9001\u91d1\u3001:\u624b\u5f62\u8981\u6c42]]\u3002<\/code><\/pre>\n<p>json\u30d5\u30a1\u30a4\u30eb\u306e\u751f\u6210<\/p>\n<p>rake swagger:docs (\u3053\u306e\u30b3\u30de\u30f3\u30c9\u3067\u306f\u30c7\u30d5\u30a9\u30eb\u30c8\u3067\u30a8\u30e9\u30fc\u306f\u8868\u793a\u3055\u308c\u307e\u305b\u3093)<\/p>\n<p>\u3059\u3079\u3066\u306e\u30a8\u30e9\u30fc\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u898b\u308b\u306b\u306f\u3001\u4ee5\u4e0b\u306e\u30b3\u30de\u30f3\u30c9\u3092\u4f7f\u7528\u3059\u308b\uff1a<\/p>\n<pre><code>SD_LOG_LEVEL=1 rake swagger:docs<\/code><\/pre>\n<p>Swagger UI\u306e\u7d71\u5408<\/p>\n<p>swagger ui\u3092\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\u3057\u3066\u304f\u3060\u3055\u3044\u3002<br><a href=\"https:\/\/github.com\/richhollis\/swagger-docs-sample\/tree\/master\/public\/api\">https:\/\/github.com\/richhollis\/swagger-docs-sample\/tree\/master\/public\/api<\/a><\/p>\n<p>\u305d\u306e\u524d\u306b\u3001\u4ee5\u4e0b\u306e\u30b3\u30fc\u30c9\u3092 swagger.rb \u306b\u8ffd\u52a0\u3057\u3066\u304f\u3060\u3055\u3044\u3002<br>API\u3068API\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u306e\u30d1\u30b9\u3092\u533a\u5225\u3059\u308b\u3002<\/p>\n<pre><code>\u30af\u30e9\u30b9 Swagger::Docs::Config\n  def self.transform_path(path, api_version)\n    # API\u3068API\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u306e\u30d1\u30b9\u3092\u533a\u5225\u3059\u308b\u3002\n    \"apidocs\/#{\u30d1\u30b9}\"\n  \u30a8\u30f3\u30c9\n\u7d42\u4e86<\/code><\/pre>\n<p>public\u306e\u4e0b\u306bapidocs\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u3092\u3001apidocs\u306e\u4e0b\u306bapi\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u3092\u4f5c\u6210\u3059\u308b\u3002<\/p>\n<p>\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\u3057\u305fswagger-ui\u3092public\/apidocs\/api\u306b\u3001index.html\u3092public\/apidocs\u306b\u30b3\u30d4\u30fc\u3057\u307e\u3059\u3002<\/p>\n<p>index.html\u3092\u7de8\u96c6\u3059\u308b<br>window.swaggerUi\u95a2\u6570\u306eswagger\u306eurl\u3092url\u306b\u5909\u66f4\uff1a\"\/apidocs\/api-docs.json \"\u306b\u5909\u66f4\u3002<br>public\/apidocs\u306e\u4e0b\u306b\u3042\u308bapi-docs.json\u30d5\u30a1\u30a4\u30eb\u3092\u6307\u3059\u3079\u304d\u3067\u3042\u308b\u3002<br>\u306a\u305c\u306a\u3089\u3001swagger.rb\u3067\u5b9a\u7fa9\u3057\u305f\u8a2d\u5b9a\u306b\u5f93\u3063\u3066\u3001\u305d\u306e\u30d1\u30b9\u306e\u4e0b\u306b\u751f\u6210\u3055\u308c\u308b\u304b\u3089\u3067\u3059\u3002<\/p>\n<p>\u3053\u308c\u3067\u6e96\u5099\u306f\u5b8c\u4e86\u3060\u3002\u3082\u3057\u30b5\u30fc\u30d0\u30fc\u3092\u52d5\u304b\u3057\u3066\u3044\u308b\u306e\u3067\u3042\u308c\u3070\u3001rails\u30b5\u30fc\u30d0\u30fc\u3092\u505c\u6b62\u3057\u3066\u518d\u8d77\u52d5\u3057\u3066\u304f\u3060\u3055\u3044\u3002\u30d6\u30e9\u30a6\u30b6\u3067\u300chttp:\/\/localhost:3000\/apidocs\/index\u00e2\u300d\u306b\u30a2\u30af\u30bb\u30b9\u3057\u3066\u307f\u3066\u304f\u3060\u3055\u3044\u3002\u5404\u30ea\u30bd\u30fc\u30b9\uff08\u6295\u7a3f\u306a\u3069\uff09\u3067\u5229\u7528\u53ef\u80fd\u306a\u30ea\u30f3\u30af\uff08\u8868\u793a\/\u975e\u8868\u793a\u3001\u64cd\u4f5c\u306e\u4e00\u89a7\u3001\u64cd\u4f5c\u306e\u5c55\u958b\u3001Raw\uff09\u3092\u30af\u30ea\u30c3\u30af\u3059\u308b\u3053\u3068\u304c\u3067\u304d\u307e\u3059\uff1a<\/p>\n<p><a href=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2024\/01\/swagger-doc-1.png\"><img decoding=\"async\" class=\"alignnone size-full wp-image-8859\" src=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2024\/01\/swagger-doc-1.png\" alt=\"\u30b9\u30ef\u30c3\u30ac\u30fc\u30c9\u30c3\u30af\" width=\"914\" height=\"386\"><\/a> <a href=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2024\/01\/swagger-doc-2.png\"><img decoding=\"async\" class=\"size-full wp-image-8857 aligncenter\" src=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2024\/01\/swagger-doc-2.png\" alt=\"\u30b9\u30ef\u30c3\u30ac\u30fc\u30c9\u30c3\u30af-2\" width=\"845\" height=\"519\"><\/a><\/p>\n<p>\u3053\u3061\u3089\u3082\u304a\u8aad\u307f\u304f\u3060\u3055\u3044: <a href=\"\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e6%8a%80%e8%a1%93%e8%ab%96%e6%96%87\/track-changes-models-data-paper-trail-gem\/\">Paper Trail Gem\u3067\u30e2\u30c7\u30eb\u30c7\u30fc\u30bf\u306e\u5909\u66f4\u3092\u8ffd\u8de1<\/a><\/p>\n<p>\u3053\u3061\u3089\u3082\u304a\u8aad\u307f\u304f\u3060\u3055\u3044\uff1a&nbsp; <a href=\"\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e6%8a%80%e8%a1%93%e8%ab%96%e6%96%87\/multi-tenant-architecture-postgresql-schemas\/\">PostgreSQL \u30b9\u30ad\u30fc\u30de\u3092\u4f7f\u7528\u3057\u305f\u30de\u30eb\u30c1\u30c6\u30ca\u30f3\u30c8 \u30a2\u30fc\u30ad\u30c6\u30af\u30c1\u30e3<\/a><\/p>\n<p>\u79c1\u305f\u3061\u306eRails\u958b\u767a\u30b9\u30ad\u30eb\u3068\u904e\u53bb\u306e\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u306b\u3064\u3044\u3066\u3082\u3063\u3068\u77e5\u308a\u305f\u3044\u3067\u3059\u304b\uff1f <a href=\"\/ja\/%e3%81%8a%e5%95%8f%e3%81%84%e5%90%88%e3%82%8f%e3%81%9b\/\">\u9023\u7d61\u3059\u308b<\/a> \u4eca\u3059\u3050\u79c1\u305f\u3061\u3068\uff01&nbsp;&nbsp;<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<section class=\"elementor-section elementor-top-section elementor-element elementor-element-1789a1ae elementor-section-boxed elementor-section-height-default elementor-section-height-default\" data-id=\"1789a1ae\" data-element_type=\"section\" data-settings=\"{&quot;background_background&quot;:&quot;classic&quot;}\">\n\t\t\t\t\t\t<div class=\"elementor-container elementor-column-gap-default\">\n\t\t\t\t\t<div class=\"elementor-column elementor-col-100 elementor-top-column elementor-element elementor-element-4236301a\" data-id=\"4236301a\" data-element_type=\"column\">\n\t\t\t<div class=\"elementor-widget-wrap elementor-element-populated\">\n\t\t\t\t\t\t<div class=\"elementor-element elementor-element-102771c0 elementor-widget elementor-widget-heading\" data-id=\"102771c0\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">\u6700\u65b0\u306e\u30a2\u30c3\u30d7\u30c7\u30fc\u30c8\u3092\u8cfc\u8aad\u3059\u308b<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-2047a8b6 elementor-widget elementor-widget-shortcode\" data-id=\"2047a8b6\" data-element_type=\"widget\" data-widget_type=\"shortcode.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<div class=\"elementor-shortcode\">\t\t\t\t\t<script type=\"text\/javascript\">\n\t\t\t\t\t\tvar gCaptchaSibWidget;\n                        var onloadSibCallbackInvisible = function () {\n\n                            var element = document.getElementsByClassName('sib-default-btn');\n                            var countInvisible = 0;\n                            var indexArray = [];\n                            jQuery('.sib-default-btn').each(function (index, el) {\n                                if ((jQuery(el).attr('id') == \"invisible\")) {\n                                    indexArray[countInvisible] = index;\n                                    countInvisible++\n                                }\n                            });\n\n                            jQuery('.invi-recaptcha').each(function (index, el) {\n                                grecaptcha.render(element[indexArray[index]], {\n                                    'sitekey': jQuery(el).attr('data-sitekey'),\n                                    'callback': sibVerifyCallback,\n                                });\n                            });\n                        };\n\t\t\t\t\t<\/script>\n\t\t\t\t\t                <script src=\"https:\/\/www.google.com\/recaptcha\/api.js?onload=onloadSibCallbackInvisible&render=explicit\" async defer><\/script>\n\t\t\t\t\n\t\t\t<form id=\"sib_signup_form_1\" method=\"post\" class=\"sib_signup_form\" action=\"\">\n\t\t\t\t<div class=\"sib_loader\" style=\"display:none;\"><img\n\t\t\t\t\t\t\tsrc=\"https:\/\/www.railscarma.com\/wp-includes\/images\/spinner.gif\" alt=\"\u30ed\u30fc\u30c0\"><\/div>\n\t\t\t\t<input type=\"hidden\" name=\"sib_form_action\" value=\"subscribe_form_submit\">\n\t\t\t\t<input type=\"hidden\" name=\"sib_form_id\" value=\"1\">\n                <input type=\"hidden\" name=\"sib_form_alert_notice\" value=\"Please fill out this field\">\n                <input type=\"hidden\" name=\"sib_form_invalid_email_notice\" value=\"Your email address is invalid\">\n                <input type=\"hidden\" name=\"sib_security\" value=\"d7f7626ab9\">\n\t\t\t\t<div class=\"sib_signup_box_inside_1\">\n\t\t\t\t\t<div style=\"\/*display:none*\/\" class=\"sib_msg_disp\">\n\t\t\t\t\t<\/div>\n                                            <div id=\"sib_captcha_invisible\" class=\"invi-recaptcha\" data-sitekey=\"6LdikOAaAAAAAJ6SWrrKVQrtw7TQpQAEnv0HS0G3\"><\/div>\n                    \t\t\t\t\t<p class=\"sib-email-area\">\r\n    <label class=\"sib-email-area\"><\/label>\r\n    <input type=\"email\" class=\"sib-email-area\" name=\"email\" required=\"required\" placeholder=\"\u96fb\u5b50\u30e1\u30fc\u30eb\u30a2\u30c9\u30ec\u30b9\">\r\n<\/p>\r\n<p class=\"sib-NAME-area\">\r\n    <label class=\"sib-NAME-area\"><\/label>\r\n    <input type=\"text\" class=\"sib-NAME-area\" name=\"NAME\" placeholder=\"\u540d\u524d\">\r\n<\/p>\r\n<p>\r\n    <input type=\"submit\" id=\"invisible\" class=\"sib-default-btn\" value=\"\u8cfc\u8aad\u3059\u308b\">\r\n<\/p>\t\t\t\t<\/div>\n\t\t\t<input type=\"hidden\" name=\"trp-form-language\" value=\"ja\"\/><\/form>\n\t\t\t<style>\n\t\t\t\tform#sib_signup_form_1 p.sib-alert-message {\n    padding: 6px 12px;\n    margin-bottom: 20px;\n    border: 1px solid transparent;\n    border-radius: 4px;\n    -webkit-box-sizing: border-box;\n    -moz-box-sizing: border-box;\n    box-sizing: border-box;\n}\nform#sib_signup_form_1 p.sib-alert-message-error {\n    background-color: #f2dede;\n    border-color: #ebccd1;\n    color: #a94442;\n}\nform#sib_signup_form_1 p.sib-alert-message-success {\n    background-color: #dff0d8;\n    border-color: #d6e9c6;\n    color: #3c763d;\n}\nform#sib_signup_form_1 p.sib-alert-message-warning {\n    background-color: #fcf8e3;\n    border-color: #faebcc;\n    color: #8a6d3b;\n}\n\t\t\t<\/style>\n\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>\n\t\t  <div class=\"related-post slider\">\r\n        <div class=\"headline\">\u95a2\u9023\u8a18\u4e8b<\/div>\r\n    <div class=\"post-list owl-carousel\">\r\n\r\n            <div class=\"item\">\r\n            <div class=\"thumb post_thumb\">\r\n    <a  title=\"\u30ab\u30df\u30ca\u30ea\u30b8\u30a7\u30e0\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e6%8a%80%e8%a1%93%e8%ab%96%e6%96%87\/%e3%82%ab%e3%83%9f%e3%83%8a%e3%83%aa%e3%82%b8%e3%82%a7%e3%83%a0\/?related_post_from=37277\">\r\n\r\n      <img decoding=\"async\" width=\"800\" height=\"300\" src=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2023\/04\/kaminari-gem.jpg\" class=\"attachment-full size-full wp-post-image\" alt=\"\u30ab\u30df\u30ca\u30ea\u30b8\u30a7\u30e0\" srcset=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2023\/04\/kaminari-gem.jpg 800w, https:\/\/www.railscarma.com\/wp-content\/uploads\/2023\/04\/kaminari-gem-300x113.jpg 300w, https:\/\/www.railscarma.com\/wp-content\/uploads\/2023\/04\/kaminari-gem-768x288.jpg 768w\" sizes=\"(max-width: 800px) 100vw, 800px\" \/>\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  <a class=\"title post_title\"  title=\"\u30ab\u30df\u30ca\u30ea\u30b8\u30a7\u30e0\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e6%8a%80%e8%a1%93%e8%ab%96%e6%96%87\/%e3%82%ab%e3%83%9f%e3%83%8a%e3%83%aa%e3%82%b8%e3%82%a7%e3%83%a0\/?related_post_from=37277\">\r\n        \u30ab\u30df\u30ca\u30ea\u30b8\u30a7\u30e0  <\/a>\r\n\r\n        <\/div>\r\n              <div class=\"item\">\r\n            <div class=\"thumb post_thumb\">\r\n    <a  title=\"\u306a\u305c2026\u5e74\u306bRuby on Rails\u958b\u767a\u8005\u3092\u96c7\u3046\u306e\u304b\uff1f\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e3%83%ad%e3%83%bc\/why-to-hire-ruby-on-rails-developers\/?related_post_from=30627\">\r\n\r\n      <img decoding=\"async\" width=\"800\" height=\"300\" src=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2019\/01\/why-to-hire-ruby-on-rails-developers-in-2022.jpg\" class=\"attachment-full size-full wp-post-image\" alt=\"2022 \u5e74\u306b Ruby on Rails \u958b\u767a\u8005\u3092\u96c7\u7528\u3059\u308b\u7406\u7531\" srcset=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2019\/01\/why-to-hire-ruby-on-rails-developers-in-2022.jpg 800w, https:\/\/www.railscarma.com\/wp-content\/uploads\/2019\/01\/why-to-hire-ruby-on-rails-developers-in-2022-300x113.jpg 300w, https:\/\/www.railscarma.com\/wp-content\/uploads\/2019\/01\/why-to-hire-ruby-on-rails-developers-in-2022-768x288.jpg 768w\" sizes=\"(max-width: 800px) 100vw, 800px\" \/>\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  <a class=\"title post_title\"  title=\"\u306a\u305c2026\u5e74\u306bRuby on Rails\u958b\u767a\u8005\u3092\u96c7\u3046\u306e\u304b\uff1f\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e3%83%ad%e3%83%bc\/why-to-hire-ruby-on-rails-developers\/?related_post_from=30627\">\r\n        \u306a\u305c2026\u5e74\u306bRuby on Rails\u958b\u767a\u8005\u3092\u96c7\u3046\u306e\u304b\uff1f  <\/a>\r\n\r\n        <\/div>\r\n              <div class=\"item\">\r\n            <div class=\"thumb post_thumb\">\r\n    <a  title=\"\u30a8\u30f3\u30bf\u30fc\u30d7\u30e9\u30a4\u30ba \u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u958b\u767a\u306b\u304a\u3051\u308b\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2 \u30a2\u30fc\u30ad\u30c6\u30af\u30c1\u30e3\u306e\u91cd\u8981\u6027\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e3%83%ad%e3%83%bc\/%e3%82%a8%e3%83%b3%e3%82%bf%e3%83%bc%e3%83%97%e3%83%a9%e3%82%a4%e3%82%ba%e3%83%bb%e3%82%bd%e3%83%95%e3%83%88%e3%82%a6%e3%82%a7%e3%82%a2%e9%96%8b%e7%99%ba%e3%81%ab%e3%81%8a%e3%81%91%e3%82%8b%e3%82%bd\/?related_post_from=36250\">\r\n\r\n      <img decoding=\"async\" width=\"800\" height=\"300\" src=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2022\/06\/Importance-of-Software-Architecture-in-enterprise-software-development.jpg\" class=\"attachment-full size-full wp-post-image\" alt=\"\u30a8\u30f3\u30bf\u30fc\u30d7\u30e9\u30a4\u30ba \u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u958b\u767a\u306b\u304a\u3051\u308b\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2 \u30a2\u30fc\u30ad\u30c6\u30af\u30c1\u30e3\u306e\u91cd\u8981\u6027\" srcset=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2022\/06\/Importance-of-Software-Architecture-in-enterprise-software-development.jpg 800w, https:\/\/www.railscarma.com\/wp-content\/uploads\/2022\/06\/Importance-of-Software-Architecture-in-enterprise-software-development-300x113.jpg 300w, https:\/\/www.railscarma.com\/wp-content\/uploads\/2022\/06\/Importance-of-Software-Architecture-in-enterprise-software-development-768x288.jpg 768w\" sizes=\"(max-width: 800px) 100vw, 800px\" \/>\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  <a class=\"title post_title\"  title=\"\u30a8\u30f3\u30bf\u30fc\u30d7\u30e9\u30a4\u30ba \u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u958b\u767a\u306b\u304a\u3051\u308b\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2 \u30a2\u30fc\u30ad\u30c6\u30af\u30c1\u30e3\u306e\u91cd\u8981\u6027\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e3%83%ad%e3%83%bc\/%e3%82%a8%e3%83%b3%e3%82%bf%e3%83%bc%e3%83%97%e3%83%a9%e3%82%a4%e3%82%ba%e3%83%bb%e3%82%bd%e3%83%95%e3%83%88%e3%82%a6%e3%82%a7%e3%82%a2%e9%96%8b%e7%99%ba%e3%81%ab%e3%81%8a%e3%81%91%e3%82%8b%e3%82%bd\/?related_post_from=36250\">\r\n        \u30a8\u30f3\u30bf\u30fc\u30d7\u30e9\u30a4\u30ba \u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u958b\u767a\u306b\u304a\u3051\u308b\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2 \u30a2\u30fc\u30ad\u30c6\u30af\u30c1\u30e3\u306e\u91cd\u8981\u6027  <\/a>\r\n\r\n        <\/div>\r\n              <div class=\"item\">\r\n            <div class=\"thumb post_thumb\">\r\n    <a  title=\"Ruby IDE: Ruby on Rails \u958b\u767a\u306b\u6700\u9069\u306a IDE\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e3%83%ad%e3%83%bc\/ruby-ide-ruby-on-rails-%e9%96%8b%e7%99%ba%e3%81%ab%e6%9c%80%e9%81%a9%e3%81%aa%e3%82%a2%e3%82%a4%e3%83%87%e3%82%a2\/?related_post_from=36125\">\r\n\r\n      <img decoding=\"async\" width=\"800\" height=\"300\" src=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2022\/01\/BEST-IDES-FOR-RUBY-ON-RAILS-DEVELOPMENT.jpg\" class=\"attachment-full size-full wp-post-image\" alt=\"Ruby on Rails \u958b\u767a\u306b\u6700\u9069\u306a\u30a2\u30a4\u30c7\u30a2\" srcset=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2022\/01\/BEST-IDES-FOR-RUBY-ON-RAILS-DEVELOPMENT.jpg 800w, https:\/\/www.railscarma.com\/wp-content\/uploads\/2022\/01\/BEST-IDES-FOR-RUBY-ON-RAILS-DEVELOPMENT-300x113.jpg 300w, https:\/\/www.railscarma.com\/wp-content\/uploads\/2022\/01\/BEST-IDES-FOR-RUBY-ON-RAILS-DEVELOPMENT-768x288.jpg 768w\" sizes=\"(max-width: 800px) 100vw, 800px\" \/>\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  <a class=\"title post_title\"  title=\"Ruby IDE: Ruby on Rails \u958b\u767a\u306b\u6700\u9069\u306a IDE\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e3%83%ad%e3%83%bc\/ruby-ide-ruby-on-rails-%e9%96%8b%e7%99%ba%e3%81%ab%e6%9c%80%e9%81%a9%e3%81%aa%e3%82%a2%e3%82%a4%e3%83%87%e3%82%a2\/?related_post_from=36125\">\r\n        Ruby IDE: Ruby on Rails \u958b\u767a\u306b\u6700\u9069\u306a IDE  <\/a>\r\n\r\n        <\/div>\r\n      \r\n  <\/div>\r\n\r\n  <script>\r\n      <\/script>\r\n  <style>\r\n    .related-post {}\r\n\r\n    .related-post .post-list {\r\n      text-align: left;\r\n          }\r\n\r\n    .related-post .post-list .item {\r\n      margin: 10px;\r\n      padding: 10px;\r\n          }\r\n\r\n    .related-post .headline {\r\n      font-size: 14px !important;\r\n      color: #999999 !important;\r\n          }\r\n\r\n    .related-post .post-list .item .post_thumb {\r\n      max-height: 220px;\r\n      margin: 10px 0px;\r\n      padding: 0px;\r\n      display: block;\r\n          }\r\n\r\n    .related-post .post-list .item .post_title {\r\n      font-size: 14px;\r\n      color: #000000;\r\n      margin: 10px 0px;\r\n      padding: 0px;\r\n      display: block;\r\n      text-decoration: none;\r\n          }\r\n\r\n    .related-post .post-list .item .post_excerpt {\r\n      font-size: 12px;\r\n      color: #3f3f3f;\r\n      margin: 10px 0px;\r\n      padding: 0px;\r\n      display: block;\r\n      text-decoration: none;\r\n          }\r\n\r\n    .related-post .owl-dots .owl-dot {\r\n          }\r\n\r\n      <\/style>\r\n      <script>\r\n      jQuery(document).ready(function($) {\r\n        $(\".related-post .post-list\").owlCarousel({\r\n          items: 2,\r\n          responsiveClass: true,\r\n          responsive: {\r\n            0: {\r\n              items: 1,\r\n            },\r\n            768: {\r\n              items: 2,\r\n            },\r\n            1200: {\r\n              items: 2,\r\n            }\r\n          },\r\n                      rewind: true,\r\n                                loop: true,\r\n                                center: false,\r\n                                autoplay: true,\r\n            autoplayHoverPause: true,\r\n                                nav: true,\r\n            navSpeed: 1000,\r\n            navText: ['<i class=\"fas fa-chevron-left\"><\/i>', '<i class=\"fas fa-chevron-right\"><\/i>'],\r\n                                dots: false,\r\n            dotsSpeed: 1200,\r\n                                                    rtl: false,\r\n          \r\n        });\r\n      });\r\n    <\/script>\r\n  <\/div>","protected":false},"excerpt":{"rendered":"<p>Rails\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u306eAPI\u3092\u4f5c\u308b\u306e\u306f\u3001Ruby on Rails\u958b\u767a\u8005\u306b\u3068\u3063\u3066\u306f\u7c21\u5358\u3060\u3002\u3044\u305a\u308c\u306b\u305b\u3088\u3001\u9867\u5ba2\u5074\u306e\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u304c\u306a\u3051\u308c\u3070\u3001API\u304c\u6b63\u5e38\u306b\u52d5\u4f5c\u3057\u3066\u3044\u308b\u304b\u3069\u3046\u304b\u3092\u3055\u307e\u3056\u307e\u306a\u9867\u5ba2\/\u9867\u5ba2\u304c\u3069\u3046\u3084\u3063\u3066\u77e5\u308b\u3053\u3068\u304c\u3067\u304d\u308b\u3067\u3057\u3087\u3046\u304b\u3002Rails\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u5185\u3067API\u3092\u30ec\u30dd\u30fc\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u7b54\u3048\u306f\u3042\u308b\u306e\u3067\u3057\u3087\u3046\u304b\uff1f\u7b54\u3048\u306f\u30a4\u30a8\u30b9\u3067\u3059\u3002\u3053\u306e\u8a18\u4e8b\u3067\u306f\u3001swagger UI\u3092\u4f7f\u3063\u3066Rails API\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u4f5c\u6210\u3059\u308b\u65b9\u6cd5\u3092\u516c\u958b\u3057\u307e\u3059\u3002\u524d\u63d0\u6761\u4ef6:-API\u30b3\u30fc\u30eb\u3092\u63d0\u4f9b\u3059\u308b\u6295\u7a3f\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u306e\u30b5\u30f3\u30d7\u30eb\u30921\u3064\u4f7f\u7528\u3057\u307e\u3059\u3002gem:-Rails\u306eAPI\u306bswagger UI\u3092\u7d71\u5408\u3059\u308b\u305f\u3081\u306b\u3001 ... \u3068\u3044\u3046gem\u3092\u4f7f\u3063\u3066\u3044\u307e\u3059\u3002<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/ruby-regex-match-guide-with-examples\/\"> <span class=\"screen-reader-text\">Ruby\u6b63\u898f\u8868\u73fe\u30de\u30c3\u30c1\u30ac\u30a4\u30c9\uff082026\uff09\u4f8b\u4ed8\u304d<\/span> \u3082\u3063\u3068\u8aad\u3080 \"<\/a><\/p>","protected":false},"author":1,"featured_media":31864,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[384],"tags":[],"class_list":["post-8856","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-technical-articles"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v26.8 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>How To Generate a Swagger Docs For Rails API - RailsCarma - Ruby on Rails Development Company specializing in Offshore Development<\/title>\n<meta name=\"description\" content=\"Making API for a Rails application is simple for a Ruby on Rails developer. In\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.railscarma.com\/ja\/\u30d6\u30ed\u30b0\/\u6280\u8853\u8ad6\u6587\/generate-swagger-docs-rails-api\/\" \/>\n<meta property=\"og:locale\" content=\"ja_JP\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How To Generate a Swagger Docs For Rails API - RailsCarma - Ruby on Rails Development Company specializing in Offshore Development\" \/>\n<meta property=\"og:description\" content=\"Making API for a Rails application is simple for a Ruby on Rails developer. In\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.railscarma.com\/ja\/\u30d6\u30ed\u30b0\/\u6280\u8853\u8ad6\u6587\/generate-swagger-docs-rails-api\/\" \/>\n<meta property=\"og:site_name\" content=\"RailsCarma - Ruby on Rails Development Company specializing in Offshore Development\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/RailsCarma\/\" \/>\n<meta property=\"article:published_time\" content=\"2016-09-23T11:21:15+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-01-10T13:06:39+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"800\" \/>\n\t<meta property=\"og:image:height\" content=\"300\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"admin\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@railscarma\" \/>\n<meta name=\"twitter:site\" content=\"@railscarma\" \/>\n<meta name=\"twitter:label1\" content=\"\u57f7\u7b46\u8005\" \/>\n\t<meta name=\"twitter:data1\" content=\"admin\" \/>\n\t<meta name=\"twitter:label2\" content=\"\u63a8\u5b9a\u8aad\u307f\u53d6\u308a\u6642\u9593\" \/>\n\t<meta name=\"twitter:data2\" content=\"4\u5206\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/\"},\"author\":{\"name\":\"admin\",\"@id\":\"https:\/\/www.railscarma.com\/#\/schema\/person\/5f2228a2dec7549056e709de6eb85d21\"},\"headline\":\"How To Generate a Swagger Docs For Rails API\",\"datePublished\":\"2016-09-23T11:21:15+00:00\",\"dateModified\":\"2024-01-10T13:06:39+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/\"},\"wordCount\":422,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/www.railscarma.com\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg\",\"articleSection\":[\"Technical Articles\"],\"inLanguage\":\"ja\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/\",\"url\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/\",\"name\":\"How To Generate a Swagger Docs For Rails API - RailsCarma - Ruby on Rails Development Company specializing in Offshore Development\",\"isPartOf\":{\"@id\":\"https:\/\/www.railscarma.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg\",\"datePublished\":\"2016-09-23T11:21:15+00:00\",\"dateModified\":\"2024-01-10T13:06:39+00:00\",\"description\":\"Making API for a Rails application is simple for a Ruby on Rails developer. In\",\"breadcrumb\":{\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#breadcrumb\"},\"inLanguage\":\"ja\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"ja\",\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#primaryimage\",\"url\":\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg\",\"contentUrl\":\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg\",\"width\":800,\"height\":300},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.railscarma.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How To Generate a Swagger Docs For Rails API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.railscarma.com\/#website\",\"url\":\"https:\/\/www.railscarma.com\/\",\"name\":\"RailsCarma - Ruby on Rails Development Company specializing in Offshore Development\",\"description\":\"RailsCarma is a Ruby on Rails Development Company in Bangalore. We specialize in Offshore Ruby on Rails Development based out in USA and India. Hire experienced Ruby on Rails developers for the ultimate Web Experience.\",\"publisher\":{\"@id\":\"https:\/\/www.railscarma.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.railscarma.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"ja\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.railscarma.com\/#organization\",\"name\":\"RailsCarma\",\"url\":\"https:\/\/www.railscarma.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"ja\",\"@id\":\"https:\/\/www.railscarma.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2020\/08\/railscarma_logo.png\",\"contentUrl\":\"https:\/\/www.railscarma.com\/wp-content\/uploads\/2020\/08\/railscarma_logo.png\",\"width\":200,\"height\":46,\"caption\":\"RailsCarma\"},\"image\":{\"@id\":\"https:\/\/www.railscarma.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/RailsCarma\/\",\"https:\/\/x.com\/railscarma\",\"https:\/\/www.linkedin.com\/company\/railscarma\/\",\"https:\/\/myspace.com\/railscarma\",\"https:\/\/in.pinterest.com\/railscarma\/\",\"https:\/\/www.youtube.com\/channel\/UCx3Wil-aAnDARuatTEyMdpg\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.railscarma.com\/#\/schema\/person\/5f2228a2dec7549056e709de6eb85d21\",\"name\":\"admin\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"ja\",\"@id\":\"https:\/\/www.railscarma.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/308867ca6c81f3aba146080c601000087180326f752c4116849ea9f514c6a4fa?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/308867ca6c81f3aba146080c601000087180326f752c4116849ea9f514c6a4fa?s=96&d=mm&r=g\",\"caption\":\"admin\"},\"sameAs\":[\"https:\/\/www.railscarma.com\/hire-ruby-on-rails-developer\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How To Generate a Swagger Docs For Rails API - RailsCarma - Ruby on Rails Development Company specializing in Offshore Development","description":"Making API for a Rails application is simple for a Ruby on Rails developer. In","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.railscarma.com\/ja\/\u30d6\u30ed\u30b0\/\u6280\u8853\u8ad6\u6587\/generate-swagger-docs-rails-api\/","og_locale":"ja_JP","og_type":"article","og_title":"How To Generate a Swagger Docs For Rails API - RailsCarma - Ruby on Rails Development Company specializing in Offshore Development","og_description":"Making API for a Rails application is simple for a Ruby on Rails developer. In","og_url":"https:\/\/www.railscarma.com\/ja\/\u30d6\u30ed\u30b0\/\u6280\u8853\u8ad6\u6587\/generate-swagger-docs-rails-api\/","og_site_name":"RailsCarma - Ruby on Rails Development Company specializing in Offshore Development","article_publisher":"https:\/\/www.facebook.com\/RailsCarma\/","article_published_time":"2016-09-23T11:21:15+00:00","article_modified_time":"2024-01-10T13:06:39+00:00","og_image":[{"width":800,"height":300,"url":"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg","type":"image\/jpeg"}],"author":"admin","twitter_card":"summary_large_image","twitter_creator":"@railscarma","twitter_site":"@railscarma","twitter_misc":{"\u57f7\u7b46\u8005":"admin","\u63a8\u5b9a\u8aad\u307f\u53d6\u308a\u6642\u9593":"4\u5206"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#article","isPartOf":{"@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/"},"author":{"name":"admin","@id":"https:\/\/www.railscarma.com\/#\/schema\/person\/5f2228a2dec7549056e709de6eb85d21"},"headline":"How To Generate a Swagger Docs For Rails API","datePublished":"2016-09-23T11:21:15+00:00","dateModified":"2024-01-10T13:06:39+00:00","mainEntityOfPage":{"@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/"},"wordCount":422,"commentCount":0,"publisher":{"@id":"https:\/\/www.railscarma.com\/#organization"},"image":{"@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#primaryimage"},"thumbnailUrl":"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg","articleSection":["Technical Articles"],"inLanguage":"ja","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/","url":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/","name":"How To Generate a Swagger Docs For Rails API - RailsCarma - Ruby on Rails Development Company specializing in Offshore Development","isPartOf":{"@id":"https:\/\/www.railscarma.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#primaryimage"},"image":{"@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#primaryimage"},"thumbnailUrl":"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg","datePublished":"2016-09-23T11:21:15+00:00","dateModified":"2024-01-10T13:06:39+00:00","description":"Making API for a Rails application is simple for a Ruby on Rails developer. In","breadcrumb":{"@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#breadcrumb"},"inLanguage":"ja","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/"]}]},{"@type":"ImageObject","inLanguage":"ja","@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#primaryimage","url":"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg","contentUrl":"https:\/\/www.railscarma.com\/wp-content\/uploads\/2016\/09\/how-to-generate-rails-api_1.jpg","width":800,"height":300},{"@type":"BreadcrumbList","@id":"https:\/\/www.railscarma.com\/blog\/technical-articles\/generate-swagger-docs-rails-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.railscarma.com\/"},{"@type":"ListItem","position":2,"name":"How To Generate a Swagger Docs For Rails API"}]},{"@type":"WebSite","@id":"https:\/\/www.railscarma.com\/#website","url":"https:\/\/www.railscarma.com\/","name":"RailsCarma - \u30aa\u30d5\u30b7\u30e7\u30a2\u958b\u767a\u306b\u7279\u5316\u3057\u305f Ruby on Rails \u958b\u767a\u4f1a\u793e","description":"RailsCarma \u306f\u30d0\u30f3\u30ac\u30ed\u30fc\u30eb\u306e Ruby on Rails \u958b\u767a\u4f1a\u793e\u3067\u3059\u3002\u5f53\u793e\u306f\u7c73\u56fd\u3068\u30a4\u30f3\u30c9\u3092\u62e0\u70b9\u3068\u3059\u308b\u30aa\u30d5\u30b7\u30e7\u30a2 Ruby on Rails \u958b\u767a\u3092\u5c02\u9580\u3068\u3057\u3066\u3044\u307e\u3059\u3002\u7d4c\u9a13\u8c4a\u5bcc\u306a Ruby on Rails \u958b\u767a\u8005\u3092\u96c7\u3063\u3066\u3001\u7a76\u6975\u306e Web \u30a8\u30af\u30b9\u30da\u30ea\u30a8\u30f3\u30b9\u3092\u5b9f\u73fe\u3057\u307e\u3057\u3087\u3046\u3002","publisher":{"@id":"https:\/\/www.railscarma.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.railscarma.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"ja"},{"@type":"Organization","@id":"https:\/\/www.railscarma.com\/#organization","name":"\u30ec\u30fc\u30eb\u30ab\u30fc\u30de","url":"https:\/\/www.railscarma.com\/","logo":{"@type":"ImageObject","inLanguage":"ja","@id":"https:\/\/www.railscarma.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.railscarma.com\/wp-content\/uploads\/2020\/08\/railscarma_logo.png","contentUrl":"https:\/\/www.railscarma.com\/wp-content\/uploads\/2020\/08\/railscarma_logo.png","width":200,"height":46,"caption":"RailsCarma"},"image":{"@id":"https:\/\/www.railscarma.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/RailsCarma\/","https:\/\/x.com\/railscarma","https:\/\/www.linkedin.com\/company\/railscarma\/","https:\/\/myspace.com\/railscarma","https:\/\/in.pinterest.com\/railscarma\/","https:\/\/www.youtube.com\/channel\/UCx3Wil-aAnDARuatTEyMdpg"]},{"@type":"Person","@id":"https:\/\/www.railscarma.com\/#\/schema\/person\/5f2228a2dec7549056e709de6eb85d21","name":"\u7ba1\u7406\u8005","image":{"@type":"ImageObject","inLanguage":"ja","@id":"https:\/\/www.railscarma.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/308867ca6c81f3aba146080c601000087180326f752c4116849ea9f514c6a4fa?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/308867ca6c81f3aba146080c601000087180326f752c4116849ea9f514c6a4fa?s=96&d=mm&r=g","caption":"admin"},"sameAs":["https:\/\/www.railscarma.com\/hire-ruby-on-rails-developer\/"]}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/posts\/8856","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/comments?post=8856"}],"version-history":[{"count":0,"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/posts\/8856\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/media\/31864"}],"wp:attachment":[{"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/media?parent=8856"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/categories?post=8856"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.railscarma.com\/ja\/wp-json\/wp\/v2\/tags?post=8856"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}