Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starcitizenwiki/apiunto
Lua Extension for MediaWiki to access the Star Citizen Wiki API
https://github.com/starcitizenwiki/apiunto
lua lua-extension mediawiki
Last synced: 5 days ago
JSON representation
Lua Extension for MediaWiki to access the Star Citizen Wiki API
- Host: GitHub
- URL: https://github.com/starcitizenwiki/apiunto
- Owner: StarCitizenWiki
- License: mit
- Created: 2019-10-23T17:19:52.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T10:33:43.000Z (over 1 year ago)
- Last Synced: 2023-09-20T04:25:36.667Z (about 1 year ago)
- Topics: lua, lua-extension, mediawiki
- Language: PHP
- Homepage: https://api.star-citizen.wiki
- Size: 91.8 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Apiunto
Lua Extension for MediaWiki to access the Star Citizen Wiki API
## Installation
```php
wfLoadExtension( 'Apiunto' );
$wgApiuntoKey = ''; // Key from api.star-citizen.wiki
$wgApiuntoUrl = 'https://api.star-citizen.wiki'; // Or self-host https://github.com/StarCitizenWiki/API
$wgApiuntoTimeout = '5'; // 5 seconds
$wgApiuntoDefaultLocale = 'de_DE'; // Or en_EN
```
## Lua Usage
```lua
local api = mw.ext.Apiunto
-- Request the ship data for the 300i with german locale
-- Docs: https://docs.star-citizen.wiki/star_citizen_api.html#raumschiffe
-- Output: https://api.star-citizen.wiki/api/v2/vehicles/300i?locale=de_DE
local ship_300i = api.get_raw( 'v2/vehicles/300i', {
locale = 'de_DE',
} )
local json = mw.text.jsonDecode( ship_300i )
-- Request data for the 300i with both german and english locale
local ship_300i = api.get_raw( 'v2/vehicles/300i' )
-- Request data for the 300i with english locale and included components
local ship_300i = api.get_raw( 'v2/vehicles/300i', {
locale = 'en_EN',
include = { 'components' }
} )
-- Request data for the Greycat Industrial ROC
-- Docs: https://docs.star-citizen.wiki/v2
-- Output: https://api.star-citizen.wiki/api/v2/vehicles/ROC
local roc = api.get_raw( 'v2/vehicles/ROC' )
-- RSI Manufacturer data
-- Docs: https://docs.star-citizen.wiki/v2
-- Output: https://api.star-citizen.wiki/api/v2/manufacturers/RSI
local rsi = api.get_manufacturer( 'RSI' )
-- RSI Manufacturer data with vehicles
-- Docs: https://docs.star-citizen.wiki/v2
-- Output: https://api.star-citizen.wiki/api/v2/manufacturers/RSI
local rsi = api.get_manufacturer( 'RSI', {
include = 'vehicles'
} )
-- Comm-Link Metadata
-- Docs: https://docs.star-citizen.wiki/v2
-- Output: https://api.star-citizen.wiki/api/v2/comm-links/12667
local commLink = api.get_comm_link_metadata( 12667 )
-- Comm-Link Metadata including images and image hashes
-- Docs: https://docs.star-citizen.wiki/star_citizen_api.html#comm-links
-- Output: https://api.star-citizen.wiki/api/v2/comm-links/12667
local commLink = api.get_comm_link_metadata( 12667, {
include = {
'images',
'images.hashes',
}
} )
-- Star System Data
-- Includable: "jumppoint_entries", "jumppoint_exits", "celestial_objects"
-- Output: https://api.star-citizen.wiki/api/v2/starsystems/sol
local sol = api.get_starsystem( 'sol' ) -- Or: 'SOL' / 355 (id)
-- Celestial object data
-- Output: https://api.star-citizen.wiki/api/v2/celestial-objects/SOL.JUMPPOINTS.CROSHAW
local jumppoint = api.get_celestial_object( 'SOL.JUMPPOINTS.CROSHAW', {
include = { }
} )
-- Output: https://api.star-citizen.wiki/api/v2/celestial-objects/2702
-- YULIN.STATION.YULINFLOTILLA
local objectById = api.get_celestial_object( 2702, {
include = { }
} )
```