grape入门

最新推荐文章于 2024-08-20 10:36:20 发布

lukaifang

最新推荐文章于 2024-08-20 10:36:20 发布

阅读量2.9k

点赞数

文章标签： grape

本文链接：https://blog.csdn.net/IT_lukaifang/article/details/108721472

版权

本文介绍了Grape，一个用于构建RESTful风格API的Ruby微框架，适用于rack或与rails/sinatra集成。Grape提供了DSL简化API开发，并内置多种功能如多格式支持、子域名/前缀限制、版本控制。通过简单的步骤，如添加到Gemfile，创建API文件并定义路由，可以快速上手。此外，文章还涉及API的描述、参数认证、约束和请求头的设置，展示了如何实现用户认证和使用命名空间来组织API。

摘要由CSDN通过智能技术生成

1.Grape是运行在rack或与rails/sinatra配合使用的一种restful风格的ruby微框架,通过提供简单的DSL(领域特定语言)简化APIs开发.它内置支持mutiple formats(),subdomain/prefix restriction, versioning等通用约束(ruby约束高于配置).详见http://intridea.github.io/grape/.

2.安装Grape

gem install grape

或者编辑Gemfile.

gem "grape"

然后

bundle install

3.基础用法
Grape APIs和Rack应用继承自Grape::API.

下面展示一段用Grape写的简单的twitter API:

module Twitter
  class API < Grape::API
    version 'v1', using: :header, vendor: 'twitter'
    format :json 
    prefix :api

    helpers do
      def current_user
        @current_user ||= User.authorize!(env)
      end

      def authenticate!
        error!('401 Unauthorized', 401) unless current_user
      end
    end

    resource :statuses do
      desc "Return a public timeline."
      get :public_timeline do
        Status.limit(20)
      end

      desc