Skip to content

Commit 8613144

Browse files
committed
Doc: Add tutorial overview
1 parent 7095c20 commit 8613144

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Test And Document Flask APIs With APIFairy
2+
3+
[APIFairy](https://apifairy.readthedocs.io/en/latest/index.html) is a minimalist API framework for Flask. Among the things you can expect when working with an API like specifying the input arguments for each endpoint or defining the response format, APIFairy excels at **automating** a lot of these things for you. It can even automatically generate your project's API documentation.
4+
5+
For your reference, these are the topics in our discussion:
6+
7+
- [Overview](00_overview.md)
8+
- [API Blueprint](01_api_blueprint.md)
9+
- [Resource Representation](02_resource_representation.md)
10+
- [Error Handling](03_error_handling.md)
11+
- [Unique Resource Identifiers](04_unique_resource_identifiers.md)
12+
- [API Authentication](05_api_authentication.md)
13+
- [API-friendly Error Messages](06_api_friendly_error_messages.md)
14+
- [API Testing Using Postman](07_api_testing_postman.md)
15+
- [API Testing And Documentation Using API Fairy](08_api_testing_documentation_using_api_fairy.md) (this article)
16+
17+
18+
### Table Of Content
19+
20+
This article is broken down into the following subsections:
21+
22+
- [Getting Started With APIFairy](#getting-started-with-apifairy)
23+
24+
25+
26+
## Getting Started With APIFairy

0 commit comments

Comments
 (0)