Skip to content

Commit 05176bd

Browse files
committed
Add API clients section to software
1 parent a06e3b6 commit 05176bd

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

src/content/docs/docs/software.mdx

+27-3
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,30 @@ These projects are directly used by, or form part of, XIVAPI itself.
3838
Thaliak, we can be sure that the API remains up to date with the latest game
3939
data.
4040

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+
4165
## Alternatives
4266

4367
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
5175
information about characters, free companies, and the like. A few libraries
5276
and/or services are available that can read this information for use.
5377

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.
5781

5882
You can also write your own library using the shared css selectors found at
5983
[xivapi/lodestone-css-selectors](https://github.com/xivapi/lodestone-css-selectors)

src/pages/api/[...path].astro

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import StarlightPage from "@astrojs/starlight/components/StarlightPage.astro";
33
import type { GetStaticPaths } from "astro";
44
55
export const getStaticPaths: GetStaticPaths = () =>
6-
["1/docs", "1/sheet/Item/42589"].map((path) => ({
6+
["1/docs", "1/openapi.json", "1/sheet/Item/42589"].map((path) => ({
77
params: { path },
88
props: { path },
99
}));

0 commit comments

Comments
 (0)