meta-api 0.0.8 → 0.1.0

data/Gemfile.lock

@@ -1,68 +0,0 @@
-PATH
-  remote: .
-  specs:
-    meta-api (0.0.8)
-
-GEM
-  remote: https://gems.ruby-china.com/
-  specs:
-    activesupport (7.0.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    byebug (11.1.3)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.5.0)
-    grape-entity (0.10.1)
-      activesupport (>= 3.0.0)
-      multi_json (>= 1.3.2)
-    hash_to_struct (1.0.0)
-    i18n (1.8.11)
-      concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.15.0)
-    multi_json (1.15.0)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rake (12.3.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  grape-entity
-  hash_to_struct
-  i18n
-  meta-api!
-  pry-byebug
-  rack
-  rack-test
-  rake (~> 12.0)
-  rspec
-
-BUNDLED WITH
-   2.3.7

data/README.md

@@ -1,166 +0,0 @@
-# Meta 框架
-
-Meta 框架是一个用于开发 Web API 的后端框架，采用 Ruby 语言编写。正如它的名字，它是用定义“元”信息的方式实现 API，同时生成一份符合 Open API 规格的接口文档。
-
-> 有关框架名称的由来，阅读[框架的名称由来](docs/名称由来.md)。
-
-## 脚手架
-
-可直接使用我的[脚手架](https://github.com/yetrun/web-frame-example)项目上手体验：
-
-```bash
-$ git clone https://github.com/yetrun/web-frame-example.git
-```
-
-## 安装
-
-在 Gemfile 中添加：
-
-```ruby
-gem 'meta-api', '~> 0.0.8' # Meta 框架处于快速开发阶段，引入时应尽量固定版本
-```
-
-然后在 Ruby 代码中引用：
-
-```ruby
-require 'meta/api'
-```
-
-> 或者可嵌入到 Rails 项目中使用，参考[为 Rails 项目带来参数验证效果](docs/Rails.md)。
-
-## 快速一览
-
-### 定义 API
-
-通过继承 `Meta::Application` 来定义一个 API 模块。（PS：以下示例的运行依赖 `ActiveRecord`）
-
-```ruby
-class NotesAPI < Meta::Application
-  get '/notes' do
-    title '查看笔记列表'
-    status 200 do
-      expose :notes, type: 'array', ref: NoteEntity
-    end
-    action do
-      render :notes, Note.all
-    end
-  end
-
-  post '/notes' do
-    title '创建新的笔记'
-    params do
-      param :note, type: 'object', ref: NoteEntity
-    end
-    status 201 do
-      expose :note, type: 'object', ref: NoteEntity.lock_scope('full')
-    end
-    action do
-      note = Note.create!(params[:note])
-      response.status = 201
-      render :note, note
-    end
-  end
-
-  get '/notes/:id' do
-    title '查看笔记'
-    params do
-      param :id, type: 'integer'
-    end
-    status 200 do
-      expose :note, type: 'object', ref: NoteEntity.lock_scope('full')
-    end
-    action do
-      note = Note.find(params[:id])
-      render :note, note, scope: 'full'
-    end
-  end
-
-  put '/notes/:id' do
-    title '更新笔记'
-    params do
-      param :note, type: 'object', ref: NoteEntity
-    end
-    status 200 do
-      expose :note, type: 'object', ref: NoteEntity.lock_scope('full')
-    end
-    action do
-      note = Note.find(params[:id])
-      note.update!(params[:note])
-      render :note, note, scope: 'full'
-    end
-  end
-
-  delete '/notes/:id' do
-    title '删除笔记'
-    status 204
-    action do
-      note = Note.find(params[:id])
-      note.destroy!
-      response.status = 204
-    end
-  end
-end
-```
-
-### 定义实体
-
-以上示例看到有用到 `NoteEntity`，它是一个预先定义的实体：
-
-```ruby
-class NoteEntity < Meta::Entity
-  property :id, type: 'integer', param: false # 不作为参数传递
-  property :title, type: 'string'
-  property :content, type: 'string', render: { scope: 'full' } # 列表页接口不返回此字段
-end
-```
-
-### 生成 API 文档
-
-通过主动调用以下的方法可以生成 Open API 的规格文档：
-
-```ruby
-NotesAPI.to_swagger_doc
-```
-
-该 Open API 文档是 JSON 格式，可以在 Swagger UI 下预览效果。如果也不乐意自己搭建 Swagger UI，可以直接使用在线的：
-
-> http://openapi.yet.run/playground
-
-### 将模块挂载在 Rack 下运行
-
-API 模块同时也是一个 Rack 中间件，它可以挂载在 Rack 下运行。假设以上文件分别位于 `notes_api.rb` 和 `note_entity.rb`，在项目下新建文件 `config.ru`，并写入：
-
-```ruby
-require 'meta/api'
-require_relative 'notes_api'
-require_relative 'note_entity'
-
-# 将文档挂载到 /api_spec 锚点下
-map '/api_spec' do
-  run ->(env) { 
-    [200, { 'CONTENT_TYPE' => 'application/json' }, [JSON.generate(NotesAPI.to_swagger_doc)]]
-    }
-end
-
-# 启动 NotesAPI 中定义的接口
-run NotesAPI
-```
-
-然后执行命令：`bundle exec rackup`，接口即可启动。
-
-## 文档
-
-- [教程](docs/教程.md)
-- [索引](docs/索引.md)
-
-## 支持
-
-你可以通过以下途径获得支持：
-
-1. 通过 GitHub 提交 [ISSUE](https://github.com/yetrun/web-frame/issues)
-2. 通过 QQ 群（489579810）获得实时答疑
-3. 对本项目提交 [Pull Request](https://github.com/yetrun/web-frame/pulls)
-
-## License
-
-LGPL-2.1

data/Rakefile

@@ -1,3 +0,0 @@
-require "bundler/gem_tasks"
-
-task :default => :spec

data/docs/Rails.md

@@ -1,61 +0,0 @@
-# 作为 Rails 插件
-
-## 安装
-
-首先，你需要将其安装在 Rails 项目中：
-
-```ruby
-gem 'meta-api', '~> 0.0.3' # 0.0.3 版本以上才提供 Rails 插件功能
-```
-
-在 config/initializers 目录下创建一个文件，例如 `meta_rails_plugin.rb`，并写入：
-
-```ruby
-require 'meta/rails'
-
-Meta::Rails.setup
-```
-
-在 `application_controller.rb` 下加入：
-
-```ruby
-class ApplicationController < ActionController::API
-  # 引入插件，同时引入 route 宏、params_on_schema 方法、json_on_schema 渲染器
-  include Meta::Rails::Plugin
-
-  # 处理参数验证错误
-  rescue_from Meta::Errors::ParameterInvalid do |e|
-    render json: e.errors, status: :bad_request
-  end
-end
-```
-
-这样，一切就准备好了。
-
-## 示例
-
-接口定义：
-
-```ruby
-class UsersController < ApplicationController
-  route '/users', :post do
-    params do
-      param :user, required: true do
-        param :name, type: 'string'
-        param :age, type: 'integer'
-      end
-    end
-  end
-  def create
-    user = User.create!(params_on_schema[:user])
-    render json_on_schema: user
-  end
-end
-```
-
-生成 Swagger 文档：
-
-```ruby
-Rails.application.eager_load! # 需要提前加载所有常量
-Meta::Rails::Plugin.generate_swagger_doc(ApplicationController)
-```

data/docs//345/220/215/347/247/260/347/224/261/346/235/245.md

@@ -1,7 +0,0 @@
-# 框架的名称由来
-
-我一直在寻找适合在团队内使用的纯 API 框架。我先是试用了 Rails API 模式，继而又尝试了 Grape 框架。面对这种框架我始终觉得缺少了些什么。这种缺憾似乎是与 API 文档相关的。我似乎每次都要先实现一遍业务逻辑，然后再想办法编写一个文档（或者反过来）。在文档和业务逻辑结合方面，Rails 做得不够好，Grape 做得更好一些，但还是不够好。
-
-直到后来，我尝试自己编写 API 框架时，一个词汇在脑海里涌现。Meta，即“元”，当我们撰写 API 文档时，实际上就是在定义 API 文档的元信息。然后，我就尝试将脑海中的想法付诸实践。编写 API，我们首先是编写 API 的元信息；然后对应地，API 的相关实现就已经有了，诸如参数的解析、实体的渲染等；然后对应地，一份 API 文档也就生成了。我们不用为了生成一份文档再单独地另写一套逻辑，我们只用定义一遍它的元信息。
-
-这就是 Meta 框架名称的由来。

data/docs//345/246/202/344/275/225/350/264/241/347/214/256.md

@@ -1,10 +0,0 @@
-# 如何贡献
-
-## 发布 Gem
-
-执行两条命令：
-
-```bash
-$ gem build meta-api.gemspec
-$ gem push meta-api-x.x.x.gem
-```