What is FinSpec?

Should API documentation be machine-readable or human-readable?

Can firms move away from legacy documentation formats, such as Word, and create, edit, and distribute specs in a way that satisfies both?

FinSpec schema is a machine-readable documentation format, which allows firms to electronically capture their API dictionary, grammar, workflows, and state machine. It also gives you the ability to capture things like change history, and layout, plus crucially also capture customer-specific transformations and normalisations.

FinSpec schema is a machine-readable documentation format developed by fixspec and open-sourced on GitHub.

FinSpec allows you to electronically capture your API dictionary, grammar, workflows, and state machine. It also gives you the ability to capture things like change history, and layout for the purposes of flowing it into a word documents perhaps, and crucially also capture customer-specific transformations and normalisations.

FinSpec is a JSON schema, so it uses JSON rather than XML, and is a well-defined API documentation format. It is also extensible which allows you to add in any specific attributes that you for your particular implementation.

FinSpec is openly available on GitHub:
https://github.com/finspec/finspec-spec

This means you can openly fork the GitHub repository and make it your own. You can also raise issues, or simply get in touch with us here at fixpec and we can help you with your implementation.

If you have any questions, please feel free to drop a comment below the video on YouTube or send us a message at happytohelp@fixspec.com.

Subscribe to the channel on YouTube (plus click the notifications bell) to stay up-to-date with all the videos we put out.

If there’s anything you’d like to share with us, please do leave us a comment below any of the videos, or reach out to us at happytohelp@fixspec.com.