@@ -38,6 +38,30 @@ These projects are directly used by, or form part of, XIVAPI itself.
38
38
Thaliak, we can be sure that the API remains up to date with the latest game
39
39
data.
40
40
41
+
42
+ ## API Clients
43
+
44
+ As a web API, XIVAPI can be utilised without any further support libraries in
45
+ any environment that is capable of making outbound requests. Libraries are
46
+ available that build further language-specific utilities and support around the
47
+ underlying API, maintained by the community:
48
+
49
+ - [ <Icon name = " github" class = " inline-icon" /> Eisenhuth/xivapi-swift] ( https://github.com/Eisenhuth/xivapi-swift ) : Swift
50
+ - [ <Icon name = " github" class = " inline-icon" /> xiv-gear-planner/xivapi-java] ( https://github.com/xiv-gear-planner/xivapi-java ) : Java
51
+
52
+ The API also exposes an OpenAPI document at [ /api/1/openapi.json] [ openapi ] that
53
+ is generated from the current API implementation, and powers the API reference
54
+ at [ /api/1/docs] [ docs ] .
55
+
56
+ :::tip
57
+
58
+ Did you write an API client? Please let us know to list the project above.
59
+
60
+ :::
61
+
62
+ [ openapi ] : /api/1/openapi.json
63
+ [ docs ] : /api/1/docs
64
+
41
65
## Alternatives
42
66
43
67
XIVAPI is not perfect for every use-case - and doesn't try to be! There is an
@@ -51,9 +75,9 @@ FFXIV's official website, Lodestone, has publicly accessible pages with
51
75
information about characters, free companies, and the like. A few libraries
52
76
and/or services are available that can read this information for use.
53
77
54
- - [ xivapi/nodestone] ( https://github.com/xivapi/nodestone ) : TypeScript, library or server.
55
- - [ xivapi/godestone] ( https://github.com/xivapi/godestone ) : Go, library.
56
- - [ xivapi/NetStone] ( https://github.com/xivapi/NetStone ) : C#/.NET, library.
78
+ - [ < Icon name = " github " class = " inline-icon " /> xivapi/nodestone] ( https://github.com/xivapi/nodestone ) : TypeScript, library or server.
79
+ - [ < Icon name = " github " class = " inline-icon " /> xivapi/godestone] ( https://github.com/xivapi/godestone ) : Go, library.
80
+ - [ < Icon name = " github " class = " inline-icon " /> xivapi/NetStone] ( https://github.com/xivapi/NetStone ) : C#/.NET, library.
57
81
58
82
You can also write your own library using the shared css selectors found at
59
83
[ xivapi/lodestone-css-selectors] ( https://github.com/xivapi/lodestone-css-selectors )
0 commit comments