一个登陆浏览api接口; 其他相关: Form_with参数的不同写法; 简单使用curl。
eeting-up app: 完成一个需求:
完成:https://github.com/chentianwei411/meeting-up-app
第四步实现API接口
Add api base and user controller
1. 生成controller
- rails g controller Api::V1::BaseController
- rails g controller Api::V1::UsersController
- 让Api::V1::UsersController < Api::V1::BaseController
2. 生成routes.rb
namespace :api do
namespace :v1 do
resources :users
..
3. 新建app/views/api/v1/users/show.json.jbuilder
json.user do
json.(@user, :id, :email, ...符号变量属性)
end
问题: api应该是: Session::Options.set request.session_options[:skip] , true,不是很理解这个方法。
def destroy_session
request.session_options[:skip] = true
end
Add name to user table
rails g migration AddNameToUser name:string
implement users can login on api(照片)
补充:2
先上代码图:
分析:
rails g controller Api::V1::Sessions
valid_password?是Devise中的方法。用于compare传入的密码和数据库的密码是否一样。
sign_in :user, @user是Devise中的方法。用于已经经过验证的user登陆。详细:连接
render nothing:true, status: 401 #只返回状态吗
此时使用Postman:
http://localhost:3000/api/v1/sessions.json?user[email]=admin@example.org&user[password]=123123
成功显示:{"session":{"id":1,"name":"admin@example.org","token":"nxzQkzgsbDZASfsJgsTS"}}
status: 200 ok
或者在terminal上curl:
curl -i -X POST -d "user[email]=admin@example.org&user[password]=123123" http://localhost:3000/api/v1/sessions.json
显示:
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"788989157ec208ecdd233d11ddca605d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 46292c8f-2d8e-4c2c-89ce-dff2aa83c61e
X-Runtime: 0.161594
Transfer-Encoding: chunked
结果:
{"session":{"id":1,"name":"admin@example.org","token":"nxzQkzgsbDZASfsJgsTS"}}%
Curl(点击见一篇博客)
curl [options/ URLs]
curl -i -X POST -d username="json" -d password="12345" http://localhost:3000/authentication
解释:
-i/--include 输出时包括protocol头部信息。
-X/--require <command> 指定什么命令
-d/--data <data> 是POST方式下传输数据。
User can update data from api
疑问?为什么需要自己写authenticate_user!方法?,current_user方法。
猜测:肯能是只要api,不会加载gem❌❌❌
先上图,然后逐句分析:
先在BaseController中加上: attr_accessor :current_user
分析:
1. token_and_options(request), 用于从请求中解析Authorization header的token和options。
例子:Authorization: Token token="abc", nonce="def",
返回token是'abc', options是{nonce: 'def'}
如果token存在,返回数组[String, Hash],否则返回nil。.
2.secure_compare() 用于比较token这个随机乱数。
然后
在Api::V1::UsersController中:
before_action :authenticate_user!, only: [:update]
def update ...end
在对应view update.json.jbuilder加上生成的json数据。
和全栈课Web Api设计中,4实作认证 API,6更新用户资料有类似。
博客https://i.cnblogs.com/EditPosts.aspx?postid=9270295(不全,最好看原来的教程)
Implement API#meetup data only return for authenticate_user
1. rails g controller Api::V1::Meeting --no-assets
然后加上
before_action :authenticate_user!, only: [:update]
def index; @meetings = Meeting.all;end
2. 加上routes.
3. 在对应view加上: json.array! @meetings, :title, :description
或者:
json.array! @meetings do |meeting|
json.title meeting.title
json.description meeting.description
end
4. 拿token 请求meeting信息。例子:
curl -i -X GET \
--header "Authorization: Token token=mSDPwft9NnGYzEFLRoaP4g9aq1s+YrclxWoQ45lkubfYbnaes4kvKATgjLFNEE3jeK5hsju4hP+3LDlIbahn2w==, \
email=bboyceo@hotmail.com" \
http://localhost:3000//api/v1/meetups
安装rspec,对login 接口进行测试
1. 添加gem 'rspec-rails'
2.安装rails g rspec:install, 然后bin/rails spec测试一下。
3.在.rspec中添加--format documentation, 方便查看测试结果。
4. rails g rspec:request api_v1/session后,直接创建了requests/api_v1/session_spec.rb文件
检查重点:
- 回传的状态码
- 回传的JSON
- 检查资料是否真的被创建/修改/删除
步骤:
- post(path, **args)
- ⚠️用到了process(:post, path, **args)方法
- expect(response).to have_http_status(200)
- 在controller动作或对应的view中的JSON数据, 赋值给data = {数据...}
- expect(response.data).to eq(data.to_json)
测试rails spec,成功。
扩展:ActionController::Base < Metal
2个基本主题:
- Get and Show
- do and redirect
Requests
每个请求,由router决定了controller和action keys。剩下的请求参数,the session, 和所有http headers会通过request accessor方法被制造出来给action,然后action被执行。
完全的请求对象可以通过请求accessor方法使用。主要用于查询HTTP headers。例如:
def server_ip
location = request.env["REMOTE_ADDR"]
render plain: "This server hosted at #{location}"
end
Parameters
所有请求参数,无论是来自URL中的查询字符串还是表格通过a POST request提交的data, 都可以用params方法返回一个hash。
例子:一个action被执行,通过/post?category=All&limit=5。 params中就会包括{"category" => "All", "limit" => 5}
例子:类似表格
<input type="text" name="post[name]" value="david">
<input type="text" name="post[address]" value="hyacintvej">
提交后会params中包括{"post" => {"name" => "david", "address" => "hyacintvej"}}
Form_with:用实例对象生成html属性的写法, 与自己写html属性的区别:
主要区别:
- 自己写先要用scope,这会解析成HTML动作(get, post等等),然后写清楚url
- 直接用实例对象,让Rails自动生成对应HTML动作和URL的话,要⚠️嵌套的结构。
- 嵌套结构是用Array,model: [@meeting, Comment.new]
- 也可以混着用:关键点是HTML动作,和url都需要正确。
次要区别:
- 如果自己写html属性,需要用到xxx_tag来生成,这需要理解使用的tag的结构
- 使用实例对象生成属性的话,方便用参数form.XXX来生成各个HTML标签,相对容易✅。
例子:
<%= form_with(scope: :post, url: meeting_comments_path(@meeting) ) do %>
<div>
<%= label_tag 'comment[message]', 'Message' %>
<%= text_area_tag('comment[message]') %>
</div>
等同于:
<%= form_with(model: [@meeting, Comment.new] ) do |form| %>
<div>
<%= form.label :message %>
<%= form.text_area :message %>
</div>
还可以混着用:(这样写✅推荐)
<%= form_with(Comment.new, url: meeting_comments_path(@meeting) ) do |form| %>
<div>
<%= form.label :message %>
<%= form.text_area :message %>
</div>
htmL:
一个登陆浏览api接口; 其他相关: Form_with参数的不同写法; 简单使用curl。的更多相关文章
- Spring框架学习笔记(9)——API接口设计相关知识及具体编码实现
最近需要设计一个API服务器,想要把API接口搞得规范一下,就通过网上搜集到了一些资料,以下便是自己的一些理解以及相关的具体实现 本文采用的是spring boot+maven的方案 restful规 ...
- 如何设计一个良好的API接口?
沟通创造价值,分享带来快乐.这里是程序员阅读时间,每天和你分享读书心得,欢迎您每天和我一起精进.今天和大家一起讨论的话题是如何设计一个良好的API接口? 作者:梁桂钊 解读:张飞洪 挑战 API是软件 ...
- API接口设计:防参数篡改+防二次请求
API接口由于需要供第三方服务调用,所以必须暴露到外网,并提供了具体请求地址和请求参数 为了防止被第别有用心之人获取到真实请求参数后再次发起请求获取信息,需要采取很多安全机制 1.首先: 需要采用ht ...
- 支付宝API接口开发相关文档以及实例
支付宝实物即时到账接口,在下载该接口之前,请确定你已经签约了即时到账的服务协议,并且账号已经开通了即时到账的权限. 口常见错误问题搜集:http://union.alipay.com/alipay/z ...
- api接口签名相关文章
http://www.cnblogs.com/hnsongbiao/p/5478645.htmlhttp://www.cnblogs.com/codeon/p/5900914.html?from=ti ...
- 如何设计一个牛逼的API接口
在日常开发中,总会接触到各种接口.前后端数据传输接口,第三方业务平台接口.一个平台的前后端数据传输接口一般都会在内网环境下通信,而且会使用安全框架,所以安全性可以得到很好的保护.这篇文章重点讨论一下提 ...
- Web API接口 安全验证
在上篇随笔<Web API应用架构设计分析(1)>,我对Web API的各种应用架构进行了概括性的分析和设计,Web API 是一种应用接口框架,它能够构建HTTP服务以支撑更广泛的客户端 ...
- 如何调用EcStore中的API接口
EcStore系统已内置了丰富的API接口供外部系统调用(接口列表见文章最下面),外部系统具体如何调用这些API呢? 例如有一个PHP的论坛需要调用ecstore系统内一个商品的详情,则可以使用b2c ...
- 整合微信小程序的Web API接口层的架构设计
在我前面有很多篇随笔介绍了Web API 接口层的架构设计,以及对微信公众号.企业号.小程序等模块的分类划分.例如在<C#开发微信门户及应用(43)--微信各个项目模块的定义和相互关系>介 ...
随机推荐
- Linux其他:环境变量配置
计算机==>右键==>属性==>高级系统设置==>环境变量==> 系统变量path后面+';python路径名
- Linux命令: 在线使用linux命令环境
https://www.tutorialspoint.com/unix_terminal_online.php
- 生产者消费者模型——wait/notify/notifyAll使用
告警系统架构如下 1. 数据处理系统处理完原始数据并入库后,发送消息到kafka系统: 2. 告警生产者从kafka系统查询消息存入告警消息队列: 3. 告警消费者从告警消息队列查询消息进行处理. 这 ...
- python webdriver 登陆163邮箱给QQ邮箱发送一个邮件,显示等待
#encoding=utf-8 import unittest import time from selenium import webdriver from selenium.webdriver i ...
- Linux服务器配置---安装centos
安装centos 1.插入光盘,启动,可以选择第一项进行安装 2.根据实际需求,一般会选择skip 3.选择语言“简体中文” 4.选择第一项 5.设置主机名字,使用默认 6.选择时区 7.设置超级用户 ...
- Linux基础命令---mkfs
mkfs 在磁盘分区上创建ext2.ext3.ext4.ms-dos.vfat文件系统,默认情况下会创建ext2.mkfs用于在设备上构建Linux文件系统,通常是硬盘分区.文件要么是设备名称(例如/ ...
- office2007-安装程序找不到office.zh-cn\*.文件
在同时安装vs2008 和 office2007 有可能会遇到个问题(如果现在安装office2007,在安装vs2008 不会出现问题, 反正会出现下面问题) 在安装office2007时总是提示“ ...
- 20145305 《网络对抗》Web安全基础实践
实践过程及结果截图 Phishing with XSS 在文本框里面写一个钓鱼网站代码就可以了 </form> <script> function hack(){ XSSIma ...
- noip 2013 提高组 Day2 部分题解
积木大赛: 之前没有仔细地想,然后就直接暴力一点(骗点分),去扫每一高度,连到一起的个数,于是2组超时 先把暴力程序贴上来(可以当对拍机) #include<iostream> #incl ...
- C++使用Socket 邮箱登录服务器验证
转载:http://blog.csdn.net/zengraoli/article/details/36866241 转载:http://blog.csdn.net/alger_magic/artic ...