Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/square/connect-api-specification
This repository contains the OpenAPI specification as well as templates for generating SDKs for Square's APIs
https://github.com/square/connect-api-specification
openapi openapi-specification sdk swagger
Last synced: 5 days ago
JSON representation
This repository contains the OpenAPI specification as well as templates for generating SDKs for Square's APIs
- Host: GitHub
- URL: https://github.com/square/connect-api-specification
- Owner: square
- License: apache-2.0
- Created: 2016-03-29T17:56:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-22T17:34:34.000Z (about 1 month ago)
- Last Synced: 2024-12-15T09:05:24.262Z (12 days ago)
- Topics: openapi, openapi-specification, sdk, swagger
- Language: Mustache
- Homepage: https://squareup.com/developers
- Size: 5.39 MB
- Stars: 73
- Watchers: 25
- Forks: 35
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Connecting to the Square API
============================
This is the project that _generates_ API clients for connecting to the public Square API. You probably want to just use one of the clients that are pre-built in a language of your choice:
* [Python](https://github.com/square/connect-python-sdk)
* [C#](https://github.com/square/connect-csharp-sdk)
* [Ruby](https://github.com/square/connect-ruby-sdk)
* [PHP](https://github.com/square/connect-php-sdk)
* [Java](https://github.com/square/connect-java-sdk)
* [Javascript](https://github.com/square/connect-javascript-sdk)
The [Connect Examples](https://github.com/square/connect-api-examples/tree/master/connect-examples/) are working sample applications that you can copy from to build your own.
Connect API Specifications
=============================
This repository contains the specifications for generating client SDKs with
[Swagger/OpenAPI](http://swagger.io/).
The canonical specification is defined in `api.json`. The templates for our
supported SDKs are located in `swagger-templates`. The configuration for each
SDK (e.g. name of the library, version number, etc.) are located in
`swagger-config`.
Configure a new language
------------------------
Generating an SDK for a new language is possible. You'll need to have a working version of `swagger-codegen` and follow these steps:
1. Check if Swagger Codegen supports the language by running:
```bash
swagger-codegen langs
```
2. If the language is supported, note swagger's name for it. We'll call it {lang}
3. Add a configuration file on [swagger-config](swagger-config/) named `config-{lang}.json`. You can check [this template](swagger-config/config-{lang}.json).
4. Create a directory on [swagger-templates](swagger-templates/) named `{lang}`. Generation scripts expect to have a folder even if no custom templates are included:
```bash
mkdir $lang
```
5. (Optional) Add custom templates for your generator. Check [Swagger Codegen Readme](https://github.com/swagger-api/swagger-codegen#modifying-the-client-library-format).
Contributing
------------
See [CONTRIBUTING.md](./CONTRIBUTING.md).
License
-------
```
Copyright 2016 - 2021 Square, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```