https://github.com/arunprakashg/wordpresscore

C# library to interact with Wordpress REST API in a fluent pattern.
https://github.com/arunprakashg/wordpresscore

csharp dotnet dotnet-standard wordpress

Last synced: about 1 month ago
JSON representation

C# library to interact with Wordpress REST API in a fluent pattern.

• Host: GitHub
• URL: https://github.com/arunprakashg/wordpresscore
• Owner: ArunPrakashG
• License: mit
• Created: 2021-02-24T12:27:10.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-13T18:31:05.000Z (11 months ago)
• Last Synced: 2024-10-03T07:21:06.585Z (about 2 months ago)
• Topics: csharp, dotnet, dotnet-standard, wordpress
• Language: C#
• Homepage:
• Size: 104 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# WordpressSharp

Library to interact with Wordpress REST API in a fluent pattern.

## NO LONGER MAINTAINED

Available on [Nuget](https://www.nuget.org/packages/WordpressCore/)

## Supported Platforms

* .net standard 2.1

* .net 5

* .net core 3.0

* .net core 3.1

## Note

This library was developed for one of my client projects to fix many limitations of existing libraries.

Library is not yet complete by any means. I have only implemented basic requests and structure. i hope to complete this soon as my time allows me.

## Example

***You can checkout full sample [Here](WordpressSharp.Demo/Program.cs)***

```cs

CookieContainer container = new CookieContainer();

			CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();

			WordpressClient client = new WordpressClient("http://demo.wp-api.org/wp-json/", maxConcurrentRequestsPerInstance: 8, timeout: 60)

			// add default user agent

			.WithDefaultUserAgent("SampleUserAgent")

			// use pre configured cookie container

			.WithCookieContainer(ref container)

			// pass custom json serializer settings if required

			.WithJsonSerializerSetting(new JsonSerializerSettings() {

				ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor,

				MissingMemberHandling = MissingMemberHandling.Ignore

			})

			// pre process responses received from the api (can be used for custom validation logic etc)

			.WithGlobalResponseProcessor((responseReceived) => {

				if (string.IsNullOrEmpty(responseReceived)) {

					return false;

				}

				// keep in mind that, returning true here completes the request by deserilizing internally, and then returning the response object.

				// returning false will terminate the request and returns a Response object with error status to the caller.

				return true;

			})

			// add default request headers

			.WithDefaultRequestHeaders(new KeyValuePair("X-Client", "Mobile"), // allows to add custom headers for requests send from this instance

									   new KeyValuePair("X-Version", "1.0"));

			// create a Posts request

			Response> posts = await client.GetPostsAsync((request) => request.OrderResultBy(Order.Ascending)

				// only get posts with published status

				.SetAllowedStatus(Status.Published)

				// specifys the response should contain embed field

				.SetEmbeded(true)

				// set scope of the request, default is view, set scope as edit for edit requests

				.SetScope(Scope.View)

				// set allowed categories of post. only posts in these categories will be in response. should be category id.

				.AllowCategories(51, 32)

				// set allowed authors of post. only posts by these authors will be in response. should be author id.

				.AllowAuthors(47, 32, 13, 53)

				// adds a cancellation token to the request, allowing to cancel the request anytime as needed

				.WithCancellationToken(cancellationTokenSource.Token)

				// sets the maximum number of posts in a single page

				.WithPerPage(20)

				// gets the first page of posts containg 20 posts, specifying 2 here will get next page. used for pagenation	

				.WithPageNumber(1)

				// adds request specific authorization. can be BasicAuth or Jwt Authentication methods. Use plugin for Jwt

				.WithAuthorization(new WordpressAuthorization("username", "password", type: WordpressClient.AuthorizationType.Jwt))

				// specifiys a response validator/processor for current request

				.WithResponseValidationOverride((response) => {

					if (string.IsNullOrEmpty(response)) {

						return false;

					}

					// returning true completes the request by returning deserialized response

					// returning false terminates the request with an error message

					return true;

				})

				// Should be called at the end of the builder to build the request as a Request object

				// pass a Callback container to get events on internal activity for this request

				.CreateWithCallback(new Callback(OnException, OnResponseReceived, OnRequestStatus))).ConfigureAwait(false);

			if (!posts.Status) {

				// Request failed

				Console.WriteLine(posts.Message);

				return -1;

			}

			foreach (Post post in posts.Value) {

				// do yer magic!

			}

```

## Goals

* Implement rest of the endpoints of REST API

* Reduce memory consumption further internally

* Replace `IAsyncEnumerable` with an alternative to support more platforms