SquiggleApi 0.0.29

SquiggleApi 0.0.29

×

测试已测试✗
语言语言 Obj-CObjective C
许可证 BSD-2-Clause
发布上次发布2020年4月

由Andy White维护。

 
依赖
AFNetworking~> 3.1
JSONModel~> 1.4
ISO8601~> 0.5
 

SquiggleApi 0.0.29

  • 由
  • Andy White

SquiggleApi

未提供描述（由Swagger Codegen生成 https://github.com/swagger-api/swagger-codegen）

此Objective C包由Swagger Codegen项目自动生成

  • API版本：0.0.1
  • 软件包版本
  • 生成软件包：class io.swagger.codegen.languages.ObjcClientCodegen

需求

该SDK需要在Xcode项目中启用了ARC (自动引用计数)。

安装与使用

使用CocoaPods从GitHub安装

将以下内容添加到Podfile

pod 'SquiggleApi', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

要指定特定的分支，请附加 , :branch => 'branch-name-here'

要指定特定的提交，请附加 , :commit => '11aa22'

使用 CocoaPods 从本地路径安装

将SDK放置在项目文件夹下（例如，/path/to/objc_project/Vendor/SquiggleApi），然后在Podfile中添加以下内容

pod 'SquiggleApi', :path => 'Vendor/SquiggleApi'

用法

导入以下内容

#import <SquiggleApi/SQApiClient.h>
#import <SquiggleApi/SQConfiguration.h>
// load models
#import <SquiggleApi/SQAddress.h>
#import <SquiggleApi/SQAddressTemplate.h>
#import <SquiggleApi/SQAuthCode.h>
#import <SquiggleApi/SQAuthCodeRequest.h>
#import <SquiggleApi/SQBatchErrorResponse.h>
#import <SquiggleApi/SQClient.h>
#import <SquiggleApi/SQFileObject.h>
#import <SquiggleApi/SQFileTemplate.h>
#import <SquiggleApi/SQGlobalTemplate.h>
#import <SquiggleApi/SQImageInfo.h>
#import <SquiggleApi/SQJSONWebToken.h>
#import <SquiggleApi/SQJsonApiResponse.h>
#import <SquiggleApi/SQLoginDetails.h>
#import <SquiggleApi/SQRenderOptions.h>
#import <SquiggleApi/SQResponseLinks.h>
#import <SquiggleApi/SQSignature.h>
#import <SquiggleApi/SQSnippet.h>
#import <SquiggleApi/SQSnippetTemplate.h>
#import <SquiggleApi/SQTemplate.h>
#import <SquiggleApi/SQUnexpectedErrorResponse.h>
#import <SquiggleApi/SQUser.h>
#import <SquiggleApi/SQUserTemplate.h>
// load API classes for accessing endpoints
#import <SquiggleApi/SQDefaultApi.h>

建议

在多线程环境中，建议为每个线程创建一个 ApiClient 实例，以避免潜在的问题。

入门

请按照 安装和用法 中的说明进行操作，然后执行以下操作

SQConfiguration *apiConfig = [SQConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: jwt)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


SQAddress* *data = [[SQAddress alloc] init]; // 

SQDefaultApi *apiInstance = [[SQDefaultApi alloc] init];

[apiInstance addAddressWithData:data
              completionHandler: ^(SQAddress* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

API端点的文档

所有URI都是相对于 https://api.squigglesignatures.com/v1

类 方法 HTTP请求 描述
SQDefaultApi addAddress POST /addresses
SQDefaultApi addAddressBatch POST /addresses/batch
SQDefaultApi addClient POST /clients
SQDefaultApi addFile POST /files
SQDefaultApi addGlobalTemplate POST /global-templates
SQDefaultApi addSnippet POST /snippets
SQDefaultApi addTemplate POST /templates
SQDefaultApi addUser POST /users
SQDefaultApi deleteAddress DELETE /addresses/{id}
SQDefaultApi 删除文件 DELETE /files/{id}
SQDefaultApi 删除全局模板 DELETE /global-templates/{id}
SQDefaultApi 删除代码片段 DELETE /snippets/{id}
SQDefaultApi 删除模板 DELETE /templates/{id}
SQDefaultApi 删除用户 DELETE /users/{id}
SQDefaultApi 编辑地址 PATCH /addresses/{id}
SQDefaultApi 编辑文件 PATCH /files/{id}
SQDefaultApi 编辑全局模板 PATCH /global-templates/{id}
SQDefaultApi 编辑代码片段 PATCH /snippets/{id}
SQDefaultApi 编辑模板 PATCH /templates/{id}
SQDefaultApi 编辑用户 PATCH /users/{id}
SQDefaultApi 查找地址 GET /addresses
SQDefaultApi 查找文件 GET /files
SQDefaultApi 查找全局模板 GET /global-templates
SQDefaultApi 查找签名 GET /signatures
SQDefaultApi 查找代码片段 GET /snippets
SQDefaultApi 查找模板 GET /templates
SQDefaultApi 查找用户 GET /users
SQDefaultApi 生成地址授权码 POST /addresses/generate-auth-code
SQDefaultApi 按ID生成地址授权码 POST /addresses/generate-auth-code/{id}
SQDefaultApi 获取地址 GET /addresses/{id}
SQDefaultApi 获取地址令牌 POST /token/address
SQDefaultApi 获取文件 GET /files/{id}
SQDefaultApi 获取全局模板 GET /global-templates/{id}
SQDefaultApi 获取图片 GET /image/{id}
SQDefaultApi 获取签名 GET /signatures/{id}
SQDefaultApi 获取代码片段 GET /snippets/{id}
SQDefaultApi 获取模板 GET /templates/{id}
SQDefaultApi 获取用户 GET /users/{id}
SQDefaultApi 获取用户令牌 POST /token/user
SQDefaultApi 渲染 POST /render

模型文档

授权文档

jwt

  • 类型: API密钥
  • API密钥参数名: 授权
  • 位置: HTTP头部

作者

发布到CocoaPods

  • 将最新更改推送到Github，并为提交打上版本号
  • 运行 pod trunk push SquiggleApi.podspec --allow-warnings