Releases: Frannsoft/FrannHammer
Young Link, Ice Climbers and Terry added
Bug Fixes and new characters support
v0.7.0
Detailed changes for this release can be found here
The KH api is available at a new endpoint!
https://api.kuroganehammer.com
The previous endpoints have been retired and turned off. More information can be found here - https://github.com/Frannsoft/FrannHammer/wiki/v0.7.0-Update
Short version:
- Ultimate data from @Kuroganehammer's site is now present - #262
- Can query data by game with the new game query parameter - #259
- Removed some unused endpoints - #258
- Check out the new Related property on API responses - #265
- Ultimate data shown in tooltips is partially available with the new expand query parameter #261
Minor changes:
Missing Smash4 Character Attribute data added - #248
Ness missing Run Speed on Smash4 Character Attributes - #256
PAC-MAN's grabs header listed on Moves - #257
Technical changes:
The API was migrated from ASP.NET Full Framework to ASP.NET Core - #260
KH site data is now stored entirely in memory instead of in an external store - #263
v0.6.0 - 6/1/18
FrannHammer API version 0.6.0+ - Major Changes - 6/1/18
This documentation has been ported from a previous wiki page
Test out the current version here!
TL;DR
- Can now get unique properties of a character back (e.g., Cloud's frame data with Limit)
- Support for unique properties includes ability to scrape data outside of KuroganeHammer.com via Pull Requests
- Now using MongoDb instead of Sql Server as a datastore
- Custom response objects via
fields
in request url are deprecated - Responses now contain Hypermedia links
- Hosted on Azure
Full project details here if you're interested - https://github.com/Frannsoft/FrannHammer/projects/1
It's been long time coming, but v0.6.0 is finally here. There are a ton of structural changes as well a slew of new features in this release. The tech stack and infrastructure has changed as well. This release has involved learning several technologies I've wanted to check out for a while and the problems I wanted to address in the API coincided with learning them.
It will still be a bit of time before this is merged into master since the changes are large.
Unique Character Properties:
Up until this release, the API had no ability to accommodate the unique properties of characters since they are all non-standard formats when compared with the rest of the moves and attributes for characters. An example of this would be Cloud's Limit Break info (Table labeled 'Limit Break' on Cloud's KH page).
The API can now handle storing this data. Right now, only Cloud's Limit Break data is stored, but I'll be adding in more of these tables as time goes on.
This also means data outside of KuroganeHammer.com can be stored and retrieved via the API. Pull Requests are welcome!
For an example of what this entails take a look at LimitBreakScraper and IUniqueDataScraper (C#). I'll follow up shortly with another post explaining this process in more detail. Feel free to ping me on twitter (@ FrannDotExe) or email me (address in my profile) in you have questions.
Current live Deployment:
http://beta-api-kuroganehammer.azurewebsites.net/api
Yes, that name is hideously long and annoying. It is also free!
I'm currently trying out Azure and if all goes well I will most likely move the production build to Azure as well. I get a lot more analytics and can respond to feedback much more quickly using Azure over the current host. Along with that, the current server has had a few issues crop up randomly that cause the API to malfunction (e.g., unplanned restarts with Sql Server not starting post-reboot).
Also, the database is now hosted by mLab. I've switched from Sql Server and Entity Framework to MongoDb with the C# driver. Storing data as documents rather than in tables of relational data increase flexibility a ton and was a major factor in enabling support for unique properties on characters.
The README
file will be updated with info pointing to the beta deployment as well as keeping the existing master deployment people will use most often.
Hypermedia Support:
You'll notice a new property in response objects named Links
. This contains endpoints for additional information around the resource you requested, hopefully making it easier to 'discover' other features as well as maintain them in your app. For more information on hypermedia APIs and HATEOAS take a look here.
Here's an example: http://beta-api-kuroganehammer.azurewebsites.net/api/characters/name/greninja (note: You might need to prettify this to make it a bit more readable)
v0.5.0
Contains the following: Milestone v0.5.0
- Refactor /movements/byname to be /movements/{name}/name - BREAKING CHANGE
- Refactor /moves/byname to /moves/name/{name} - BREAKING CHANGE
- Add Short hop, full hop, aerial jump and ledge jump data
- Add /name support to all /moves calls
- Add /name support for character attributes
- RunSpeed is not properly added to CharacterAttributes table
- Add /name support for all character calls
- Create table to map FirstActionableFrame data from Moves table - RESPONSE DATA MODEL CHANGE FOR /api/characters/{id}/detailedmoves
- Fix the displayname seeding for Captain Falcon and Wii Fit Trainer
- Obsolete the Calculate API - DEPRECATED
- Obsolete DataSynchro project - DEPRECATED
- Refactor Models
- Update assembly versioning
- Update Swagger page
- Add /name support for SmashAttributeTypes
Wiki updates will be made upon final version 0.5.0 release.
Thank you for reading the release notes!
v0.5.0_rc
Contains the following: Milestone v0.5.0
NOTE: This is a release candidate and contents are subject to change.
- Refactor /movements/byname to be /movements/{name}/name - BREAKING CHANGE
- Refactor /moves/byname to /moves/name/{name} - BREAKING CHANGE
- Add Short hop, full hop, aerial jump and ledge jump data
- Add /name support to all /moves calls
- Add /name support for character attributes
- RunSpeed is not properly added to CharacterAttributes table
- Add /name support for all character calls
- Create table to map FirstActionableFrame data from Moves table - RESPONSE DATA MODEL CHANGE FOR /api/characters/{id}/detailedmoves
- Fix the displayname seeding for Captain Falcon and Wii Fit Trainer
- Obsolete the Calculate API - DEPRECATED
- Obsolete DataSynchro project - DEPRECATED
- Refactor Models
- Update assembly versioning
- Update Swagger page
- Add /name support for SmashAttributeTypes
Wiki updates will be made upon final version 0.5.0 release.
Thank you for reading the release notes!
v0.4.6
Patch that includes the following issues:
v0.4.5
Contains the following: Milestone v0.4.5
- Add full KH page link to character table entries
- Convert build process from appveyor ci yml to Cake
- Update database
- Create character moves calls that bring back attribute data using the more strongly typed tables
- Owner property is not filled out by default on requests that return it
- Create a call that returns all non-move metadata about a character
Wiki updates have been made to the Character page for this release:
- Create a call that returns all non-move metadata about a character
- Create character moves calls that bring back attribute data using the more strongly typed tables
- Added
full_url
property to Character default response body.
Thank you for reading the release notes!
v0.4.5_rc
Contains the following: Milestone v0.4.5
NOTE: This is a release candidate and contents are subject to change.
- Add full KH page link to character table entries
- Convert build process from appveyor ci yml to Cake
- Update database
- Create character moves calls that bring back attribute data using the more strongly typed tables
- Owner property is not filled out by default on requests that return it
- Create a call that returns all non-move metadata about a character
Wiki updates will be made upon final version 0.4.5 release.
Thank you for reading the release notes!
v0.4.0
Contains the following: Milestone v0.4.0
- Autocancel scraped values don't properly decode '>' sign
- Implement Redis for caching
- Strip data from hitbox columns that is not numeric
- Lucas' thumbnail url is wrong
- Friendly name logic is removing the 's' on names than end with 's'
- Update API with additional data KH is adding
- Implement API analytics
- Create new call to send in a complex 'search' request
Thank you for reading the release notes.