开源项目 `grape-swagger-rails` 使用教程

1. 项目目录结构及介绍

grape-swagger-rails/
├── app/
│   ├── assets/
│   │   ├── config/
│   │   │   └── manifest.js
│   │   ├── images/
│   │   ├── javascripts/
│   │   └── stylesheets/
│   ├── controllers/
│   ├── helpers/
│   ├── mailers/
│   ├── models/
│   └── views/
├── bin/
│   └── rails
├── config/
│   ├── environments/
│   ├── initializers/
│   ├── locales/
│   ├── routes.rb
│   └── application.rb
├── db/
│   ├── migrate/
│   └── schema.rb
├── lib/
│   ├── tasks/
│   └── grape_swagger_rails/
├── public/
├── spec/
├── vendor/
├── Gemfile
├── Gemfile.lock
├── Rakefile
└── README.md

目录结构介绍

• app/: 包含应用程序的主要代码，如控制器、模型、视图、资产等。
  • assets/: 存放静态资源文件，如JavaScript、CSS、图片等。
  • controllers/: 存放控制器文件，处理用户请求。
  • models/: 存放模型文件，处理数据逻辑。
  • views/: 存放视图文件，负责展示数据。
• bin/: 存放可执行文件，如Rails命令行工具。
• config/: 存放应用程序的配置文件，如路由、环境配置、初始化文件等。
• db/: 存放数据库相关文件，如迁移文件和模式文件。
• lib/: 存放自定义库和扩展代码。
• public/: 存放公开访问的静态文件。
• spec/: 存放测试文件。
• vendor/: 存放第三方库和插件。
• Gemfile: 定义项目所需的RubyGems依赖。
• Gemfile.lock: 锁定Gemfile中定义的依赖版本。
• Rakefile: 定义Rake任务。
• README.md: 项目说明文档。

2. 项目启动文件介绍

config/routes.rb

config/routes.rb 是Rails应用程序的路由配置文件。在这个文件中，你可以定义URL路径与控制器动作之间的映射关系。

Rails.application.routes.draw do
  mount GrapeSwaggerRails::Engine => '/swagger'
end

config/application.rb

config/application.rb 是Rails应用程序的主配置文件，包含应用程序的基本配置信息。

require_relative "boot"

require "rails/all"

Bundler.require(*Rails.groups)

module MyApp
  class Application < Rails::Application
    config.load_defaults 6.1
  end
end

3. 项目的配置文件介绍

config/initializers/grape_swagger_rails.rb

config/initializers/grape_swagger_rails.rb 是 grape-swagger-rails 的初始化配置文件，用于配置Swagger UI。

GrapeSwaggerRails.options.url      = '/swagger_doc'
GrapeSwaggerRails.options.app_url  = 'http://localhost:3000'
GrapeSwaggerRails.options.app_name = 'My API'

config/environments/

config/environments/ 目录下包含不同环境的配置文件，如 development.rb, test.rb, production.rb 等。

# config/environments/development.rb
Rails.application.configure do
  config.cache_classes = false
  config.eager_load = false
  config.consider_all_requests_local = true
  config.action_controller.perform_caching = false
  config.active_support.deprecation = :log
  config.active_record.migration_error = :page_load
  config.assets.debug = true
  config.assets.quiet = true
end

通过以上配置，你可以启动并配置 grape-swagger-rails 项目，使其正常运行并展示Swagger UI。