Skip to content

Commit 6e0f136

Browse files
Chore: Update ReadMe
1 parent c459058 commit 6e0f136

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,23 @@
44
The OpenAPI specification for the Paystack API
55

66
## Getting Started
7-
Quick intro on OpenAPI and how to setup
8-
9-
## Structure
10-
Folder structure and file contents
7+
The [OpenAPI specification](https://swagger.io/specification/) provides another alternative to test the Paystack API.
8+
You can download the specification and make use of it on:
9+
- [SwaggerHub](https://swagger.io/tools/swaggerhub/)
10+
- [OpenAPI (Swagger) Editor](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi)
1111

1212
## Components
13-
Parameters that requires futher explanation
13+
There are three main folders of interest in this repo:
14+
- `main`: This contains a comprehensive specification of the Paystack API:
15+
- resources: This contains individual endpoints in each API category
16+
- responses: This contains the models for responses
17+
- schemas: This contains models for each endpoint
18+
- paystack.yml: This is the entry point for all components
19+
- `dist`: In order to allow making use of the specification, we built a single file from all components in `main` folder.
20+
- `sdk`: This is a single file specification being used to client library generation. It contains just enough parameters for our client libraries.
1421

1522
## Issues
16-
How to report an issue
23+
Kindly [open an issue](https://github.com/PaystackOSS/openapi/issues) if you discover any bug or have problems using this library.
1724

1825
## License
1926
This repository is made available under the MIT license. Kindly read the [LICENSE](https://github.com/PaystackOSS/openapi/blob/main/LICENSE) file for more information.

0 commit comments

Comments
 (0)