Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 5.35 KB

README.md

File metadata and controls

83 lines (56 loc) · 5.35 KB
Raw

CI Build License: MIT NuGet CodeFactor Open Source Helpers Language Twitter

GhostSharp

This is a wrapper around v5.0 of the Content and Admin APIs. They are RESTful JSON APIs built into the core of the Ghost blogging platform. Check out the official Ghost API docs and read a little about my experience using them.

Usage

Accessing the Content API

If you need to access the Content API, all you need is the URL of your site and a Content API Key, available on the "Integrations" page. Once you have those pieces of information, you can access any "public" content.

var ghost = new GhostSharp.GhostContentAPI("https://grantwinney.com", "a6d33f1b95ff17adf0f787a70a");
var settings = ghost.GetSettings();

Console.WriteLine($"Welcome to {settings.Title}: {settings.Description}\r\n");
Console.WriteLine($"Navigation: {string.Join(", ", settings.Navigation.Select(x => x.Label))}");

Output:

Welcome to Grant Winney: We learn by doing. We've all got something to contribute.

Navigation: Home, APIs, Lambda, Rasp PI, About Me, CV

Accessing the Admin API

If you need to access the Admin API, all you need is the URL of your site and an Admin API Key, also available on the "Integrations" page. Once you have those pieces of information, you can access any "private" content.

var ghost = new GhostSharp.GhostAdminAPI("https://grantwinney.com", 
    "5cf706fd7d4a33066550627a:9e5ed2b90e40f68573b0ccaf4aef666b047fc9867ad285b2e219eed5503bae53");
var site = ghost.GetSite();

Console.WriteLine($"Welcome to <a href='{site.Url}'>{site.Title}</a>\r\n");
Console.WriteLine($"Running Ghost v{site.Version}");

Output:

Welcome to <a href='https://grantwinney.com/'>Grant Winney</a>

Running Ghost v2.23

You can optionally pass in a version number for the API (i.e. 4.0), or omit it to default to the latest (currently 5.0). I'm only able to support one version (due to there only being 24 hours in a day), but setting that to a lesser value may work in some cases too.

Running the Tests

The tests are setup to run against an actual instance of the Ghost blog, using a valid API key. There are details in the TestBase.cs class that you'll need to fill in, such as a valid API key, valid post ID, valid post slug, etc, etc.

Problems?

Open an issue, and include errors, unexpected behavior, steps to reproduce, etc. The more details, the better!

Feel free to open a PR if you figure out how to fix it.

Ideas?

Open an issue. I can't promise when new features or suggestions will get implemented, but I'll check them out.

Release Notes

  • 2.0.0 - ⭐ Upgraded to .NET 6 and API v5. Implemented the stable endpoints, except for members.
  • 1.0.9 - 🐛 Noticed that pages aren't being created; other refactoring.
    Breaking change: Eliminated Page in favor of a single Post object again, for simplicity. The split wasn't necessary as a Page is just a Post that doesn't end up in feeds. Also, a few fields in a Post don't play nicely when creating pages, but I figured out a different way to omit those.
  • 1.0.8 - 🐛 Several fields marked as updateable that aren't. (thx for the heads up @unnanego)
    Breaking change: This led to a larger refactoring, which might break some current implementations. Properties in the Post class that cannot be changed now have private setters (instead of just an attribute on them). The Page class was completely separated from the Post class, so RestSharp could correctly deserialize objects coming from Ghost.
  • 1.0.7 - ⭐ Implement the Themes admin endpoint. (thx for pointing me in the right direction @naz)
  • 1.0.6 - ⭐ Implement API v3.
  • 1.0.4 - 🧹 Code cleanup. Added license to NuGet package.
  • 1.0.3 - ⭐ Implement Admin API v2 endpoints (posts, pages, images, site)
    Breaking change: GhostAPI is now split into GhostContentAPI and GhostAdminAPI
  • 1.0.1 - 🧹 Added comments to aid in intellisense.
  • 1.0.0 - ⭐ Implement Content API endpoints.