Some API endpoints for articles

Define the API with canapi
Implement canapi::Provider for Post (only get and list actually)
Use these functions to serve the API (/api/v1/posts/<id> and /api/v1/posts)
Document the API with Swagger (couldn’t test it, I hope it will be served correctly 😕)

It is a first step for #5

igalic (Migrated from github.com) reviewed 2 years ago

👀

Cargo.toml

												
			@@ -5,6 +5,7 @@ version = "0.2.0"
		
			[dependencies]
		
			activitypub = "0.1.3"
		
			atom_syndication = "0.6"
		
			canapi = "0.1"

Plume_migration_agent commented 2 years ago

exciting Version number

docs/api.yaml

												
			@@ -0,0 +1,45 @@
		
			openapi: "3.0"

Plume_migration_agent commented 2 years ago

is this autogenerated?

plume-api/src/lib.rs

												
			@@ -0,0 +13,4 @@
		
			            }
		
			        }
		
			    };
		
			}

Plume_migration_agent commented 2 years ago

sometimes i dream of lisp indentation style in Javascript. soon, I’ll start dreaming of lisp indentation style in rust

plume-models/src/posts.rs

												
			@@ -58,0 +93,4 @@
		
			    }
		
			    fn create(_conn: &PgConnection, _query: PostEndpoint) -> Result<PostEndpoint, Error> {
		
			        unimplemented!()

Plume_migration_agent commented 2 years ago

what’s the point of these queries and the override of the query variable?

Plume_migration_agent commented 2 years ago

aahh, you’re fetching different parts of the same article, and stuffing them into different boxes of the query variable!

po/gl.po

Plume_migration_agent commented 2 years ago

why does this file keep changing with every new build?

src/api/posts.rs

Plume_migration_agent commented 2 years ago

such as?

elegaanz (Migrated from github.com) reviewed 2 years ago

docs/api.yaml

												
			@@ -0,0 +1,45 @@
		
			openapi: "3.0"

Plume_migration_agent commented 2 years ago

not yet, but it may be possible thanks to canapi…

elegaanz (Migrated from github.com) reviewed 2 years ago

po/gl.po

Plume_migration_agent commented 2 years ago

it is updated every time you run Plume. However, extracting i18n related task to an external tool may be better… 🤔

elegaanz (Migrated from github.com) reviewed 2 years ago

src/api/posts.rs

Plume_migration_agent commented 2 years ago

For instance, if you GET /api/v1/posts?title=Hello%20world, only posts with the Hello world title should be shown (title is not the best example, but author_id could be interesting for instance)

elegaanz (Migrated from github.com) reviewed 2 years ago

plume-models/src/posts.rs

												
			@@ -58,0 +93,4 @@
		
			    }
		
			    fn create(_conn: &PgConnection, _query: PostEndpoint) -> Result<PostEndpoint, Error> {
		
			        unimplemented!()

Plume_migration_agent commented 2 years ago

actually, the PostEndpoint type is here to represent both the client’s query and the result sent by the API. filter is what is requested by the client, so if any filter have been specified I update the SQL query to only return the requested posts.

elegaanz (Migrated from github.com) reviewed 2 years ago

plume-models/src/posts.rs

												
			@@ -58,0 +93,4 @@
		
			    }
		
			    fn create(_conn: &PgConnection, _query: PostEndpoint) -> Result<PostEndpoint, Error> {
		
			        unimplemented!()

Plume_migration_agent commented 2 years ago

not sure if I’m clear, tell me if not 😁

i just realized how easy CLI mappings would be to implement, once the API is in place.

trinity-1686a reviewed 2 years ago

src/api/posts.rs

trinity-1686a commented 2 years ago

So is this (at least partially) blocked by #149, or not related?

elegaanz (Migrated from github.com) reviewed 2 years ago

src/api/posts.rs

Plume_migration_agent commented 2 years ago

No, actually we just need to get the raw query params, and deserialize them to PostEndpoint with something like serde_qs.

The pull request has been merged as 236cf14406.

No reviewers

A: Backend

C: Feature

S: Ready for review

No Milestone

No Assignees

2 Participants

Notifications

Due Date

No due date set.

Dependencies

This pull request currently doesn't have any dependencies.

#245 Some API endpoints for articles